Get market versions

Request

The endpoint will return the markets in active status according to the query parameters: market code and registration type

Security

OAuth2(Required scopes: read)

Path

projectIdstringrequired

Customer's project id

Query

marketCodestring^[A-Z]{2}$

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

Example:marketCode=MK

activePoliciesboolean

Filter to enable viewing only active policies in markets. Default: false, returns all policies within market

Default:false

pageTokenstring

Add token from previous query if needed to retrieve more markets

pageSizeinteger, (int32)

Number of markets per page

registrationTypestring, (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

Default:"ALPHANUMERIC_SENDER_ID"

Enum Value	Description
ALPHANUMERIC_SENDER_ID	Alpha sender IDs
LONG_NUMBER	Long Numbers for SMS
SHORT_CODE	Short Codes for SMS
RCS_AGENT	RCS agent

curl -i -X GET \
  'https://senderid.registrations.api.sinch.com/v1/projects/{projectId}/markets/details?marketCode=MK&activePolicies=false&pageToken=string&pageSize=0&registrationType=ALPHANUMERIC_SENDER_ID' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json

marketVersionsArray of objects(MarketVersion)

List of Market versions that matches with the request criteria.

nextPageTokenstring

next token to be used to retrieve more markets

Example:"CgptYXJrZXRDb2RlEk4KRnR5cGUuZ29vZ2xlYXBpcy5jb20vc2luY2gubnVtcmVnLnBvbGljeS52MWFscGhhMi5NYXJrZXRWZXJzaW9uUGFnZU1hcmsSBAoCS1o="

totalSizeinteger, (int32)

Total Number of markets.

Example:50

Response

{
  "marketVersions": [
    { … }
  ],
  "nextPageToken": "CgptYXJrZXRDb2RlEk4KRnR5cGUuZ29vZ2xlYXBpcy5jb20vc2luY2gubnVtcmVnLnBvbGljeS52MWFscGhhMi5NYXJrZXRWZXJzaW9uUGFnZU1hcmsSBAoCS1o=",
  "totalSize": 50
}

We'd love to hear from you!