API & DOCS

My Account            

Used to set up advanced features for a tracking number

Use the Number Configuration - Advanced API to set up advanced features for a tracking number

Use the Number Configuration - Advanced API to set up advanced features for a tracking number within a DialogTech's account.

📘

Base URL for Number Configuration - Advanced

https://secure.dialogtech.com/ibp_api.php

Parameter List

ParameterRequiredAcceptsMax LengthNotesUsage
actionYesString: routing.advancedn/aOnly accepts routing.advanced to set up advanced features for a tracking numberDefines the API Call as "Number Configuration - Advanced" type
access_keyYesStringn/aAccess Key from the Key Manager within a DialogTech accountCredentials used for access to the API for a particular DialogTech account
secret_access_keyYesStringn/aSecret Access Key from the Key Manager within a DialogTech accountCredentials used for access to the API for a particular DialogTech account
phone_numberYesUnformatted Phone Numbern/a
record_callNo0 or 1 or 2 or 310 - Do not record the call (default)
1 - Record after transfer
2 - Record whole call
3 - Record up to transfer
Determines if the call will be recorded or not.
play_warningNo0 or 1 or 2 or 310 - Play warning to caller and recipient (default)
1 - Play warning to caller only
2 - Play warning to Recipient only
3 - Do not play warning
Determines if and to whom the "This call may be recorded for quality purposes" message is played
reverse_lookupNo0 or 110 - Do not perform a reverse lookup (default)
1 - Perform a reverse lookup (additional charges may apply)
Determines if there should be a reverse lookup performed against the caller
always_ringNo0 or 110 - Do not play any artificial ring-sounds to the caller (default)
1 - Play artificial ring-sounds to the caller to help mitigate silence during transfers
Determines if an artificial ring sound should be utilized to impact the calling experience. This setting could help if calls are experiencing silence during the transfers.
caller_audioNoStringn/aLink to an audio file in your account to be used as caller whisper audioDetermines the audio file to be used as caller whisper audio
recipient_audioNoStringn/aLink to an audio file in your account to be used as recipient whisper audioDetermines the audio file to be used as recipient whisper audio
ga_referrerNoString100UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributedDetermines the UTM Referrer used with DialogTech's integration into Google Universal Analytics integration
ga_contentNoString100UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributedDetermines the UTM Content used with DialogTech's integration into Google Universal Analytics integration
ga_campaignNoString100UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributedDetermines the UTM Campaign used with DialogTech's integration into Google Universal Analytics integration
ga_termNoString100UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributedDetermines the UTM Term used with DialogTech's integration into Google Universal Analytics integration
ga_mediumNoString100UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributedDetermines the UTM Medium used with DialogTech's integration into Google Universal Analytics integration

Using this API

Example Response

<response>
    <result>success</result>
    <result_description>Phone number updated successfully</result_description>
</response>