Get an Agent's Regions

GET Method

The Get an Agent's Regions API allows you retrieve details about all the regions where an agent’s services are available.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
To send any RCS messages, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Base URL

https://rcs-api.<pod>.kaleyra.io/v1/<sid>

API Domain and Value

api_domain	Value
IN pod	`https://rcs-api.in.kaleyra.io`
NA pod	`https://rcs-api.na.kaleyra.io`

API Request to get an Agent's Regions

To get an agent's regions, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/agent_regions endpoint with the following request method:

Request Format

The following is the request format to get an agent's regions:

curl --location --request GET 'https://<api_domain>/v1/<sid>/rcs/agent/agent_regions'\
--header 'api-key: <api-key>' \
--header 'Content-Type: <content-type>'

Sample Request Format

The following is the sample request format to get an agent's regions:

curl --location --request GET 'https://rcs.api.na.kaleyra.io/v1/xxxxx6913850xxxx/rcs/agent/agent_regions'\
--header 'api-key: xxxxx3b8497f58a94e84b671aca43xxxx' \
--header 'Content-Type: application/json'

URL Parameters and Headers

The following is the list of parameters and headers to send the outgoing message request:

Parameter/Headers	Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	XXXXX6913850XXXX	Yes
`Content-Type`	String	Indicates the format of the content the API will be processing.	The only allowed value is application/JSON	Yes
`api-key`	String	API key generated from kaleyra.io account.	XXXXX3b8497f58a94e84b671aca43XXXX	Yes

Sample Success Response

The following is a sample success response:

  "code": "RCS902",
  "message": "Regions fetched successfully",
  "data": [
 {
            "id": "45XXXXab-7XXa-4XX3-9XXe-fbXXXXXXXXa1",
            "region_name": "/v1/regions/9mobile-nigeria",
            "display_name": "Nigeria: 9 Mobile",
            "management_type": "GOOGLE_MANAGED",
            "managment_type_value": 2,
            "carrier_enabled": true,
            "hosting_region": "HOSTING_REGION_UNSPECIFIED"
        },
        {
            "id": "59XXXXbb-5XX0-4XXf-aXX4-57XXXXXXXX2e",
            "region_name": "/v1/regions/amx-tracfone",
            "display_name": "United States: Tracfone",
            "management_type": "GOOGLE_MANAGED",
            "managment_type_value": 2,
            "carrier_enabled": true,
            "hosting_region": "NORTH_AMERICA"
        }
  ],
  "error": {}
}

Parameters and Descriptions for Success Response

The following are the parameters and descriptions for success response:

Parameter	Data Type	Description	Example
`id`	UUID	Unique identifier for the region record.	45XXXXab-7XXa-4XX3-9XXe-fbXXXXXXXXa1
`region_name`	String	The region resource name from Google API.	`/v1/regions/9mobile-nigeria`
`display_name`	String	Human-readable name of the region.	Nigeria: 9 Mobile
`management_type`	String	Management type as string. The following are the supported string: "GOOGLE_MANAGED" "PARTNER_MANAGED" "CARRIER_MANAGED"	"GOOGLE_MANAGED"
`managment_type_value`	Integer	Management type as integer code.	2
`carrier_enabled`	Boolean	Whether the carrier is enabled for this region.	true
`hosting_region`	String	Filter parameter to query regions by hosting region. The following are the supported values: "HOSTING_REGION_UNSPECIFIED" "HOSTING_REGION_EUROPE" "HOSTING_REGION_ASIA_PACIFIC" "HOSTING_REGION_US"	HOSTING_REGION_US

Sample Failure Response

The following are the sample failure responses:

RCS Not Enabled

{
  "code": "RCS601",
  "message": "RCS Channel is not enabled for this User",
  "data": [],
  "error": {
    "error_code": "RCS_CHANNEL_DISABLED",
    "error_message": "RCS Channel is not enabled for this User"
  }
}

Method Not Allowed

{
  "code": "RCS405",
  "message": "Method not allowed",
  "data": [],
  "error": {
    "error_code": "METHOD_NOT_ALLOWED",
    "error_message": "Method not allowed"
  }
}

Gateway Error

{
  "code": "RCS502",
  "message": "Internal Gateway Error",
  "data": [],
  "error": {
    "error_code": "RCS_CHANNEL_INTERNAL_ERROR",
    "error_message": "Internal Gateway Error"
  }
}

Updated about 1 month ago