Currently, the Configuration API supports Read General Settings, Read Voice Pool Settings, and Read Messaging Settings methods for Client resources. Create, Update, and Delete are not supported.

Update Client Add Voice

Description: Adds a voice talent to the list of talents available for use by the Client.

User Roles: Sysadmin or IT User.

Method: POST /configuration/clients/[{client}/]voicePool/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)No

The ID of the Client to add the voice talent to.

idvoiceIdInteger (ID)Yes

The voice ID of the voice talent to be added, possible values include:

Voice IDNameLanguageDialectGender
1JulieEnglishAmericanF
2JuanitaSpanishAmericanF
3KateEnglishBritishF
4GiselePortuguesePortugueseF
5BobEnglishAmericanM
6Gruff-MEnglishAmericanM
8Gruff-FEnglishAmericanF
9LeeEnglishAmericanM
10ScarletEnglishAmericanF
11ClaudineFrenchCanadianF

Body:

None

Response Code: 204 No Content

Body:

None

Add a voice talent to a Client

#Request
POST /configuration/clients/4199/voicePool/11
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
204 No Content
CODE

Update Client Remove Voice

Description: Removes a voice talent from the list of talents available for use by the Client.

User Roles: Sysadmin or IT User

Method: DELETE /configuration/clients/[{client}/]voicePool/{id}

Parameters:

Path/Query Parameter NameVariable NameTypeMandatory?Description
clientclientIdInteger (ID)No

The ID of the Client to remove the voice talent from.

idvoiceIdInteger (ID)Yes

The voice ID of the voice talent to be removed, possible values include:

Voice IDNameLanguageDialectGender
1JulieEnglishAmericanF
2JuanitaSpanishAmericanF
3KateEnglishBritishF
4GiselePortuguesePortugueseF
5BobEnglishAmericanM
6Gruff-MEnglishAmericanM
8Gruff-FEnglishAmericanF
9LeeEnglishAmericanM
10ScarletEnglishAmericanF
11ClaudineFrenchCanadianF

Body:

None

Response Code: 204 No Content

Body:

None

Remove a voice talent from a Client

#Request
POST /configuration/clients/4199/voicePool/11
Host: localhost.com
Content-Type: application/json
Accept: application/json

#Response
204 No Content
CODE

List Countries

Description: Lists the allowed countries for the client.

User Roles: Sysadmin or IT User

Method: GET  /configuration/clients/countries

Parameters:

None

Body:

None

Response Code: 200 OK

Body:

AttributeTypeMandatory?Description

ArrayYes

abbreviation

AttributeTypeMandatory?Details
nameStringYesThe full name of the country. 
countryCode
LongNo

International Organization for Standardization (ISO) Country code . 

idNumberYesThe value of the Country ID.

Get the Allowed Countries List

#Request
GET /configuration/clients/countries 
Host: localhost.com
Content-Type: application/json
Accept: application/json   

#Response
200 OK
Content-Type: application/json
 

[
  {
    "id": 11,
    "countryCode": "93",
    "name": "Afghanistan",
    "countryName": "Afghanistan"
  },
  {
    "id": 12,
    "countryCode": "355",
    "name": "Albania",
    "countryName": "Albania"
  },
  {
    "id": 13,
    "countryCode": "213",
    "name": "Algeria",
    "countryName": "Algeria"
  },
  {
    "id": 165,
    "countryCode": "1",
    "name": "American Samoa",
    "countryName": "American Samoa"
  },
  {
    "id": 14,
    "countryCode": "376",
    "name": "Andorra",
    "countryName": "Andorra"
  },
  {
    "id": 166,
    "countryCode": "244",
    "name": "Angola",
    "countryName": "Angola"
  },

  ...

 
  {
    "id": 105,
    "countryCode": "243",
    "name": "Zaire",
    "countryName": "Zaire"
  },
  {
    "id": 161,
    "countryCode": "260",
    "name": "Zambia",
    "countryName": "Zambia"
  },
  {
    "id": 106,
    "countryCode": "263",
    "name": "Zimbabwe",
    "countryName": "Zimbabwe"
  }
]
CODE

Top of Page