Get Journey Token List

Note:

• For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

• For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

ListJourneys

post

Body

Responses

200

A successful response

application/json

post

HTTPcURLJavaScriptPython

POST /ListJourneys HTTP/1.1
Host: $BASE_URL.Zalo
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "filter": {
    "date_from": "2025-06-14T17:19:03.876Z",
    "date_to": "2025-06-14T17:19:03.876Z",
    "is_charged": true,
    "journey_id": "text",
    "oa_id": "text",
    "phone": "text",
    "status": "Z"
  },
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "sort": "text"
  }
}

200

A successful response

{
  "journeys": [
    {
      "created_at": "2025-06-14T17:19:03.876Z",
      "error_code": 1,
      "error_message": "text",
      "expired_at": "2025-06-14T17:19:03.876Z",
      "id": "text",
      "is_charged": true,
      "journey_id": "text",
      "journey_token": "text",
      "phone": "text",
      "status": "Z",
      "updated_at": "2025-06-14T17:19:03.876Z"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

Request:

curl --location '$BASE_URL.Zalo/ListJourneys' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "filter": {
    "date_from": "<dateTime>",
    "date_to": "<dateTime>",
    "journey_id": "<string>",
    "phone": "<string>"
  },
  "paging": {
    "after": "<string>",
    "before": "<string>",
    "limit": "<integer>",
    "sort": "<string>"
  }
}'

Response:

{
  "journeys": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "error_code": 0,
      "error_message": "string",
      "expired_at": "2019-08-24T14:15:22Z",
      "id": "string",
      "is_charged": true,
      "journey_id": "string",
      "journey_token": "string",
      "phone": "string",
      "status": "Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}

Request body structure

Parameters	Data type	Describe
id	int64	OA ID
journey_id	int64	Journey ID
phone	string	Recipient phone number
is_charged	bool	Charge or not
status	string	Status Z: Newly created P: Enable N: Disable
date_from	string<date-time>	Start date
date_to	string<date-time>	End date

Return data attribute structure

Parameters	Data type	Describe
id	int64	Journey ID on eTelecom system
journey_id	string	Journey ID
journey_token	string	Trip code activated
phone	string	Recipient phone number
status	string	Status Z: Newly created P: Enable N: Disable
is_charged	bool	Charge or not
expires_at	string<date-time>	Expiration time
updated_at	string<date-time>	Update time
created_at	string<date-time>	Creation time