markets

Get market codes list

The endpoint retrieves the list of market codes available for alphanumeric registration. Market code is an optional query param, if used, the response will contain a list with the same market code if it is available; the list will be empty if it is not.

get/v1/projects/{projectId}/markets/availability

Path parameters

projectIdstring required

Customer's project id

Query parameters

marketCodestring

Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)

languagestring

Language used to print country names. Default: en

registrationType'ALPHANUMERIC_SENDER_ID' | 'LONG_NUMBER' | 'SHORT_CODE' | 'RCS_AGENT' enum

Type of Sender ID to be registered. Options: ALPHANUMERIC_SENDER_ID for alpha registration, LONG_NUMBER for long number sms services registration, SHORT_CODE for short code sms services registration, RCS_AGENT for RCS agent

Response

Example response

{
  "markets": [
    {
      "marketCode": "AE",
      "marketName": "United Arab Emirates"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.