markets
Get market versions
The endpoint will return the markets in active status according to the query parameters: market code and registration type
get/v1/projects/{projectId}/markets/details
Path parameters
projectIdstring required
Customer's project id
Query parameters
marketCodestring
Filter by ISO market code (ex. 'IT', 'AU', 'KW', etc.)
activePoliciesboolean
Filter to enable viewing only active policies in markets. Default: false, returns all policies within market
pageTokenstring
Add token from previous query if needed to retrieve more markets
pageSizeinteger
Number of markets per page
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
OK
Example response
{
"marketVersions": [
{
"createTime": "2023-09-17 06:22:34.372747",
"id": "ddede333432ededed2",
"majorVersion": 1,
"marketCode": "AU",
"registrationType": "ALPHANUMERIC_SENDER_ID",
"specialConditions": {
"chainedSpecialConditions": [
{
"answer": "No",
"description": "Promotional, marketing or advertising purposes",
"policyId": "43342642354352344",
"prompt": "Is this brand registered as a local legal entity in this market?"
}
],
"policyId": "43342642354352344",
"prompt": "Is this brand registered as a local legal entity in this market?"
},
"status": "ACTIVE"
}
],
"nextPageToken": "CgptYXJrZXRDb2RlEk4KRnR5cGUuZ29vZ2xlYXBpcy5jb20vc2luY2gubnVtcmVnLnBvbGljeS52MWFscGhhMi5NYXJrZXRWZXJzaW9uUGFnZU1hcmsSBAoCS1o=",
"totalSize": 50
}