SmsCountryCodes

You can use REST API v2 calls to obtain information about SMS country codes in your Cloudpath system.
New for 5.8

The following table lists the properties that can be used in the body of a SmsCountryCodes-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).

Resource: SmsCountryCode

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
guid String No like, sort No The unique identifier for this country code.
name String Yes like, sort No The name of the country for this code.
code int Yes like, sort No The country code.
links links       Self-referencing link.

SmsCountryCode URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

SmsCountryCode URIs and Actions

URI Action Description Return Codes
/system/smsCountryCodes GET Returns the list of country codes in the Cloudpath system.

401 - Unauthorized
/system/smsCountryCodes{guid} GET Returns details about the specified country code.

404 - Not found

401 - Unauthorized

Example of Using GET for SmsCountryCodes

This example demonstrates how to obtain information about all SmsCountryCodes in your system .

URI:

This example uses the following URI: 

 https://Jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/system/smsCountryCodes

where:

  • https://Jeff245.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • yRCjJObWR6ER is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about all existing country codes.

Note: The snippet below is only partial output displaying three country codes. 

{
    "page": {
        "page": 1,
        "pageSize": 10,
        "totalCount": 243
    },
    "contents": [
        {
            "guid": "10000",
            "code": 93,
            "name": "Afghanistan",
            "iso2Code": "AF",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/system/smsCountryCodes/10000",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "10010",
            "code": 358,
            "name": "Aland Islands",
            "iso2Code": "AX",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/system/smsCountryCodes/10010",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "10020",
            "code": 355,
            "name": "Albania",
            "iso2Code": "AL",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/system/smsCountryCodes/10020",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "10030",
            "code": 213,
            "name": "Algeria",
            "iso2Code": "DZ",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/system/smsCountryCodes/10030",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }

Parent topic: Core Cloudpath APIs