Get Specific Calling Profile Template

HTTP Method

GET

URI

Copy 
{{baseUrl}}/api/v3/callingProfileTemplates/{Id}

Request Parameters

Parameter

Mandatory

Type

Description

Id

Ö

string

Numeric primary key of the template.

Example Response

Copy 
{
  "ovocSipConnectionType": "IPGROUP_TYPE",
  "sbcOnboardingScriptId": 5461228,
  "sbcCleanupScriptId": 5461229,
  "sbcOcUploadNumberScriptId": 5000,
  "sbcOcReleaseNumberScriptId": 5001,
  "requiredScriptParameters": [
    {
      "name": "CacProfile",
      "kind": "well-known"
    },
    {
      "name": "Carrier-MediaSecurity_Secure-Unsecure",
      "kind": "custom"
    },
    {
      "name": "Carrier-ProxyAddress",
      "kind": "custom"
    },
    {
      "name": "Carrier-SIPPort",
      "kind": "custom"
    },
    {
      "name": "Carrier-TransportType_UDP-TCP-TLS",
      "kind": "custom"
    },
    {
      "name": "CarrierHostName",
      "kind": "well-known"
    },
    {
      "name": "CarrierMainLine",
      "kind": "well-known"
    },
    {
      "name": "CarrierPassword",
      "kind": "well-known"
    },
    {
      "name": "CarrierUserName",
      "kind": "well-known"
    },
    {
      "name": "OnlinePstnGateway",
      "kind": "well-known"
    },
    {
      "name": "ProxySet",
      "kind": "well-known"
    }
  ],
  "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
}

Responses

■ 200 Success

Parameters

Type

Description
ovocSipConnection string Specifies the OVOC SIP connection type used by the template.
sbcOnboardingScript integer Unique identifier of the SBC script executed during customer onboarding.
sbcCleanupScriptId integer Unique identifier of the SBC script executed during customer cleanup or deprovisioning.
sbcOcUploadNumberScriptId integer Unique identifier of the SBC script used to upload telephone numbers to Operator Connect.
sbcOcReleaseNumberScriptId integer Unique identifier of the SBC script used to release telephone numbers from Operator Connect.
requiredScriptParameters array

List of parameters required by the associated SBC scripts.

■ Name: parameter name. For example, "CacProfile"
■ Kind: "Well-known" or "Custom"
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 purpose.
usageCount integer Number of calling profiles currently using this template.
msCallingProfileIds array 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. Null if unavailable.
whenUpdated date-time Date and time when the template was last updated, in ISO 8601 format. Null if unavailable.