Get Calling Profile Templates
HTTP Method
GET
URI
{{baseUrl}}/api/v3/callingProfileTemplatesExample Response
{
"firstPage": null,
"lastPage": null,
"nextPage": null,
"previousPage": null,
"currentPage": 0,
"pageSize": 100,
"totalPages": 1,
"totalRecords": 24,
"data": [
{
"id": 3,
"templateName": "Sandbox3_BYOC_CustomScript",
"templateDescription": "Onboarding a new BYOC OC Customer",
"usageCount": 1,
"msCallingProfileIds": [
"4a5ed485-93bc-4b85-bc9b-fd7b2a8d8d10"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 4,
"templateName": "Sandbox3_SP1_02_OC_Adv",
"templateDescription": "Onboarding OC Customer with Advanced Settings",
"usageCount": 1,
"msCallingProfileIds": [
"99bc2f96-92e1-4cd8-b856-b50fbb4b293e"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 5,
"templateName": "Sandbox3_SP1_02_OC_BYOC1",
"templateDescription": "Onboarding a new BYOC OC Customer with SIP Group Name",
"usageCount": 1,
"msCallingProfileIds": [
"600a0ecb-2003-4ddc-8d91-dd98bca15786"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 6,
"templateName": "Sandbox3_SP1_02_OC_Adv_1",
"templateDescription": "Onboarding OC Customer with Site Name",
"usageCount": 0,
"msCallingProfileIds": [
"609a787d-484a-4ae3-8389-fad3e16bbefe"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 8,
"templateName": "Sandbox3_SP1_02_OC_BYOC2",
"templateDescription": "Onboarding a new BYOC OC customer with SIP Group Name and Site Name",
"usageCount": 12,
"msCallingProfileIds": [
"c788a841-d79c-484f-9e3e-bb0726d3ad26"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 9,
"templateName": "Sandbox3_BYOC_APAC",
"templateDescription": "Sandbox3_BYOC_APAC",
"usageCount": 1,
"msCallingProfileIds": [
"fcdd70da-df67-4ac5-a9fa-5d69da190622"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 10,
"templateName": "Sandbox3_APAC_OC_Adv",
"templateDescription": "Onboarding OC customer with Advance settings",
"usageCount": 0,
"msCallingProfileIds": [
"fcdd70da-df67-4ac5-a9fa-5d69da190622"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 13,
"templateName": "ZoomOC_Dev_CallingProfile_EMEA02",
"templateDescription": "Onboarding Zoom OC Customer in Zoom Dev EMEA environment",
"usageCount": 8,
"msCallingProfileIds": [
"4a5ed485-93bc-4b85-bc9b-fd7b2a8d8d10",
"609a787d-484a-4ae3-8389-fad3e16bbefe"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 14,
"templateName": "Sandbox3_US_OC_Adv",
"templateDescription": "Onboarding OC customer with Advanced settings",
"usageCount": 9,
"msCallingProfileIds": [
"ab86ef82-ce9e-4ead-befb-4aa954b64872"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 15,
"templateName": "Sandbox3_US_OC_BYOC",
"templateDescription": "Onboarding a new BYOC OC customer",
"usageCount": 6,
"msCallingProfileIds": [
"ab86ef82-ce9e-4ead-befb-4aa954b64872"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 16,
"templateName": "ZoomOC_GO_CallingProfile_US",
"templateDescription": "Onboarding Zoom OC Customer in Zoom GO US environment",
"usageCount": 4,
"msCallingProfileIds": [
"ab86ef82-ce9e-4ead-befb-4aa954b64872"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 18,
"templateName": "Sandbox3_US_OC_BYOC_Adv",
"templateDescription": "Onboarding a new BYOC OC customer with SIP Group Name and Site Name",
"usageCount": 1,
"msCallingProfileIds": [
"ab86ef82-ce9e-4ead-befb-4aa954b64872"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 19,
"templateName": "Sandbox3_EMEA02_Generic_BYOC",
"templateDescription": null,
"usageCount": 0,
"msCallingProfileIds": [
"4a5ed485-93bc-4b85-bc9b-fd7b2a8d8d10"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 20,
"templateName": "GFIT_Sandbox3_SP1_02_OC_BYOC",
"templateDescription": "Onboarding a new GFIT OC Customer with SIP Group Name",
"usageCount": 3,
"msCallingProfileIds": [
"99bc2f96-92e1-4cd8-b856-b50fbb4b293e"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 21,
"templateName": "TNG_Sandbox3_SP1_02_OC_BYOC",
"templateDescription": "Onboarding a new TNG OC Customer with SIP Group Name",
"usageCount": 0,
"msCallingProfileIds": [
"99bc2f96-92e1-4cd8-b856-b50fbb4b293e"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 22,
"templateName": "Tobi_test_multiple_calling_profiles",
"templateDescription": "test multiple calling profiles",
"usageCount": 8,
"msCallingProfileIds": [
"4a5ed485-93bc-4b85-bc9b-fd7b2a8d8d10",
"cd208b87-d81f-44dc-ac8c-802d5ee0b0c9",
"609a787d-484a-4ae3-8389-fad3e16bbefe"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 23,
"templateName": "Sandbox3_US_OC_Telnyx",
"templateDescription": "Onboarding OC customer with Telnyx Token Authentication",
"usageCount": 4,
"msCallingProfileIds": [
"ab86ef82-ce9e-4ead-befb-4aa954b64872"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 25,
"templateName": "ZoomOC_GO_CallingProfile_APAC",
"templateDescription": "Onboarding Zoom OC Customer in Zoom GO APAC environment",
"usageCount": 0,
"msCallingProfileIds": [
"fcdd70da-df67-4ac5-a9fa-5d69da190622"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 26,
"templateName": "ZoomOC_GO_CallingProfile_EMEA",
"templateDescription": "Onboarding Zoom OC Customer in Zoom GO EMEA environment",
"usageCount": 1,
"msCallingProfileIds": [
"99bc2f96-92e1-4cd8-b856-b50fbb4b293e"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 27,
"templateName": "ZoomOC_Dev_CallingProfile_US",
"templateDescription": "Onboarding Zoom OC Customer in Zoom Dev US environment",
"usageCount": 0,
"msCallingProfileIds": [
"ab86ef82-ce9e-4ead-befb-4aa954b64872"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 28,
"templateName": "ZoomOC_Dev_CallingProfile_APAC",
"templateDescription": "Onboarding Zoom OC Customer in Zoom Dev APAC environment",
"usageCount": 0,
"msCallingProfileIds": [
"fcdd70da-df67-4ac5-a9fa-5d69da190622"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 29,
"templateName": "VoiceFlexOC_CallingProfile_EMEA02",
"templateDescription": "VoiceFlex OC Onboarding",
"usageCount": 0,
"msCallingProfileIds": [
"4a5ed485-93bc-4b85-bc9b-fd7b2a8d8d10",
"609a787d-484a-4ae3-8389-fad3e16bbefe"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 30,
"templateName": "Sandbox3_EMEA_OC_Telnyx",
"templateDescription": "Onboarding OC customer with Telnyx Token Authentication",
"usageCount": 0,
"msCallingProfileIds": [
"99bc2f96-92e1-4cd8-b856-b50fbb4b293e"
],
"whenCreated": null,
"whenUpdated": null
},
{
"id": 31,
"templateName": "Sandbox3_HKBN_NT",
"templateDescription": "Sandbox3_HKBN_NT",
"usageCount": 2,
"msCallingProfileIds": [
"fcdd70da-df67-4ac5-a9fa-5d69da190622"
],
"whenCreated": null,
"whenUpdated": null
}
]
}Responses
| ■ | 200 Success |
|
Parameters |
Type |
Description |
|---|---|---|
|
currentPage |
integer |
Current page number returned in the paginated result set. |
|
pageSize |
integer |
Number of records returned per page. |
|
totalPages |
integer |
Total number of available pages. |
|
totalRecords |
integer |
Total number of records matching the request criteria. |
|
data |
array |
List of calling profile templates returned for the current page. |
|
id |
integer |
Unique identifier of the calling profile template. |
|
templateName |
string |
Name of the calling profile template. |
|
templateDescription |
string |
Description of the calling profile template and its intended use. |
|
usageCount |
integer |
Number of calling profiles currently associated with this template. |
|
msCallingProfileIds |
string |
List of Microsoft Calling Profile IDs associated with this template. |
|
whenCreated |
($date-time) |
Date and time when the template was created, in ISO 8601 format. |
|
whenUpdated |
(date-time) |
Date and time when the template was last modified, in ISO 8601 format. |
|
firstPage |
string |
URI of the first page in the result set. |
|
lastPage |
string |
URI of the last page in the result set. |
|
nextPage |
string |
URI of the next page in the result set. Empty or null if no next page exists. |
|
previousPage |
string |
URI of the previous page in the result set. Empty or null if no previous page exists. |
| ■ | 400 Bad Request |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 500 Internal Server Error |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk" |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |