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
Parameter List
Parameter | Required | Accepts | Max Length | Notes | Usage |
---|---|---|---|---|---|
action | Yes | String: routing.advanced | n/a | Only accepts routing.advanced to set up advanced features for a tracking number | Defines the API Call as "Number Configuration - Advanced" type |
access_key | Yes | String | n/a | Access Key from the Key Manager within a DialogTech account | Credentials used for access to the API for a particular DialogTech account |
secret_access_key | Yes | String | n/a | Secret Access Key from the Key Manager within a DialogTech account | Credentials used for access to the API for a particular DialogTech account |
phone_number | Yes | Unformatted Phone Number | n/a | ||
record_call | No | 0 or 1 or 2 or 3 | 1 | 0 - 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_warning | No | 0 or 1 or 2 or 3 | 1 | 0 - 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_lookup | No | 0 or 1 | 1 | 0 - 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_ring | No | 0 or 1 | 1 | 0 - 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_audio | No | String | n/a | Link to an audio file in your account to be used as caller whisper audio | Determines the audio file to be used as caller whisper audio |
recipient_audio | No | String | n/a | Link to an audio file in your account to be used as recipient whisper audio | Determines the audio file to be used as recipient whisper audio |
ga_referrer | No | String | 100 | UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed | Determines the UTM Referrer used with DialogTech's integration into Google Universal Analytics integration |
ga_content | No | String | 100 | UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed | Determines the UTM Content used with DialogTech's integration into Google Universal Analytics integration |
ga_campaign | No | String | 100 | UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed | Determines the UTM Campaign used with DialogTech's integration into Google Universal Analytics integration |
ga_term | No | String | 100 | UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed | Determines the UTM Term used with DialogTech's integration into Google Universal Analytics integration |
ga_medium | No | String | 100 | UTM which will be passed to Google Universal Analytics if the integration is set up and the call isn't otherwise attributed | Determines 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>