GET /api/tenants/{FedmemberID}/countrycodes

Returns a list of telephone country codes for the tenant.

Note: In version 2020.1.0, country names are supported as well as the numeric telephone dialing codes. If your data only includes codes, only the codes are returned. It's best to upgrade your data to include country names as well as codes, using the PUT /api/tenants/{FedmemberID}/countrycodes operation. If provided, country names are displayed in the Community Manager developer portal user interface.

Authorization Roles/Permissions: No permission required. Login is not required.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/tenants/{FedmemberID}/countrycodes

Sample Request

The example below shows a request for the country codes for the specified tenant.

Sample Request URL

https://{hostname}/api/tenants/acmepaymentscorp/countrycodes

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
FedmemberID	Path	String	Required	Unique ID for a specific tenant. Same as TenantID.

Response

If successful, this operation returns HTTP status code 200, with the country codes that are set up for the tenant.

Sample Response

The sample response below shows successful completion of this operation. In this example, the tenant supports three country codes.

Sample response headers

GET http://{hostname}/api/tenants/acmepaymentscorp/countrycodes HTTP/1.0
Host: {hostname}
Accept: application/json
Date: Wed, 04 Mar 2020 20:58:47 GMT

Sample response body #1: application/json (versions up to 2020.1.0)

In versions up to 2020.1.0, only the numeric telephone dialing id is supported. For these versions, or in version 2020.1.0 and later if country names were not provided, only the country codes are returned, as shown below.

{
  "CountryCode":[
    {
      "id":"+1"
    },
    {
      "id":"+353"
    },
    {
      "id":"+44"
    },
    {
      "id":"+91"
    }
  ]
}

Sample response body #2: application/json (valid in version: 2020.1.0 and later)

Country name is supported in 2020.1.0 and later, as well as country code. If the country names were provided, either via the Community Manager developer portal user interface or via the PUT /api/tenants/{FedmemberID}/countrycodes operation, name and id is returned for each entry, as shown in the example below.

[
  {
    "id": "+1",
    "Name": "United States and Canada"
  },
  {
    "id": "+353",
    "Name": "Ireland"
  },
  {
    "id": "+44",
    "Name": "United Kingdom"
  },
  {
    "id": "44-1534",
    "Name": "Jersey"
  },
  {
    "id": "91",
    "Name": "India"
  }
]

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
CountryCodes	CountryCodes	Contains information about the telephone country codes supported on the platform.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics