Download PDF
Download page LCID Packages API Methods.
LCID Packages API Methods
LCID Packages allow a Service to display different LCIDs to a call recipient depending on their location. They are assigned to Outbound Services and Inbound traffic to these numbers are routed to a single Inbound Service.
Currently, the Configuration API supports Read, List, and Get List Info methods for LCID Packages objects. Create, Update, and Delete are not yet supported.
Get LCID Package List Info
Description: Gets metadata for a list of LCID Packages.
User Roles: Sysadmin, Superuser, or Manager
Method: GET /configuration/lcidPackages/info[?client={client}]
Parameters:
| Path/Query Parameter Name | Variable Name | Type | Mandatory? | Description |
|---|---|---|---|---|
| client | clientId | Integer (ID) | No | Restricts the list to entries that are specifically associated with this particular Client. |
Body:
None
Response Code: 200 OK
Body:
| Key or Attribute | Type | Mandatory? | Description |
|---|---|---|---|
| size | Integer | Yes | Total number of entries in the list. |
| lastModified | DateTime | No | The last date & time that the list was updated. This information might not be available. This is formatted according to the definition of dateTime in the XML Schema specification. For JSON responses, it is represented as the number of milliseconds since midnight on January 1, 1970 (GMT). |
Get the metadata for a list of LCID Packages, filtered by a Client
#Request
GET /configuration/lcidPackages/info?client=19636
Host: localhost.com
Content-Type: application/json
Accept: application/json
#Response
200 OK
Content-Type: application/json
{
"size": 1,
"lastModified": 1337586262000
}List LCID Packages
Description: Lists LCID Packages configured for a Client.
User Roles: Sysadmin, Superuser, or Manager
Method: GET /configuration/lcidPackages?[client={client}&]offset={n}&count={n}
Parameters:
| Path/Query Parameter Name | Variable Name | Type | Mandatory? | Description |
|---|---|---|---|---|
| client | clientId | Integer (ID) | No | Specifies the Client for which you want to retrieve the list of LCID Packages |
| count | n | Integer | Yes | Specifies the number of items to return in the list. There is a hard cap of 1000 items. |
| offset | n | Integer | Yes | Specifies the offset from 0, based on count, to start listing from. |
Body:
None
Response Code: 200 OK
Body:
| Key | Type | Mandatory? | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| next | URI | No | A URI for the next page of entries. If next is not present, or blank, then there are no pages after this one. | ||||||||||||||||
| lcidPackage | Array | No | A container for a page of LCID Package entries. The page size is controlled via count and offset in the request.
|
Get a list of LCID Packages for a Client
#Request (JSON)
GET /configuration/lcidPackages?client=19636&offset=0&count=10
Host: localhost.com
Content-Type: application/json
Accept: application/json
#Response
200 OK
Content-Type: application/json
{
"lcidPackage": [ {
"id": 8963,
"name": "InsideSales_52805",
"description": "LCID for InsideSales"
}],
"next": null
}
Read LCID Package
Description: Gets information about an LCID Package.
User Roles: Sysadmin, Superuser, or Manager
Method: GET /configuration/lcidPackages/{id}
Parameters:
| Path/Query Parameter Name | Variable Name | Type | Mandatory? | Description |
|---|---|---|---|---|
| id | packageId | Integer (ID) | Yes | The ID of the LCID Package you want to query |
Body:
None
Response Code: 200 OK
Body:
| Key | Type | Mandatory? | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| service | Array | No | An array of one or more Service IDs that are assigned to the LCID Package.
| ||||||||||||||||||||||||
| number | Array | No | An array of one or more phone numbers that are contained in the LCID Package.
|
Read configuration properties of an LCID Package
#Request (JSON)
GET /configuration/lcidPackages/8963
Host: localhost.com
Content-Type: application/json
Accept: application/json
#Response
200 OK
Content-Type: application/json
{
"service": [{"id": 38373}],
"number": [
{
"phoneId": 200290,
"number": "2137844315",
"areaCode": "213",
"state": "CA",
"country": "UNITED STATES OF AMERICA"
},
{
"phoneId": 200291,
"number": "2137844316",
"areaCode": "213",
"state": "CA",
"country": "UNITED STATES OF AMERICA"
},
{
"phoneId": 200292,
"number": "2137844317",
"areaCode": "213",
"state": "CA",
"country": "UNITED STATES OF AMERICA"
},
{
"phoneId": 200293,
"number": "2137844318",
"areaCode": "213",
"state": "CA",
"country": "UNITED STATES OF AMERICA"
}
]
}