API for managing the callback entries, which are used to automatically associate an inbound access number (e.g. DID, UIFN, local access or toll-free) to an account for the purpose of triggering a callback.
GET /accounts/{AccountId}/services/callback
Return a list of callback entries for the specified account.
GET /accounts/services/callback/{LookupValue}
Return a specific callback entry by Id.
POST /accounts/services/callback
Create a new callback entry.
PUT /accounts/services/callback
Update an existing callback entry.
DELETE /accounts/services/callback/{Id}
Delete the specified callback entry.
Looking up a Resource (single objects, lists and tabular data)
Creating a Resource
Updating a Resource
Deleting a Resource
{
"CallbackId": 0,
"Dnis": "",
"Account": "",
"Password": "",
"Leg1Origin": "",
"Leg1CallOrigination": "",
"Leg1Destination": "",
"Leg1Language": "",
"Leg2Origin": "",
"Leg2CallOrigination": "",
"Leg2Destination": "",
"Leg2Language": "",
"Alias": "",
"ExpirationDateTime": "",
"Enabled": false,
"Description": ""
}
The CALLBACK table is used to automatically associate an inbound access number (e.g. DID, UIFN, local access or toll-free) to an account for the purpose of triggering a callback.
Field Name | Type | Size | Description |
---|---|---|---|
CALLBACK_ID | bigint | 8 | Primary key |
DNIS | varchar | 40 | This is the DNIS number assigned to this account for the purposes of triggering a callback and/or administering their account. Note: This entry must match exactly to the incoming DNIS after being processed by the optional ANI_FORMAT(SYS_ANI_FORMAT) and DNIS_FORMAT (SYS_DNIS_FORMAT) tables. |
ACCOUNT | varchar | 40 | This is the account number to be associated with the DNIS and it will be used for authentication, authorization and billing purposes. |
PASSWORD | varchar | 20 | This is a password that is used by the optional Web Interface (WEB_CALLBACK_USE_CALLBACK_TABLE) as an additional level of security when triggering calls via the web that requires the web user to have to enter this password before being able to trigger a call from this entry. |
LEG1_ORIGIN | varchar | 40 | The entry specifies the Origin that will be used during authorization and rating when placing a call to the first leg of the callback. By setting a different Origin you can cause the system to select a different Rate Schedule Item (and thus Rate Plan) as well as a different Rate Plan entry allowing different rates, billing increments, rating tiers to be charged between the two call legs. Note: This column overrides the CB_CALLBACK_ORIGIN_LEG1 Module Setting and can be overridden by the CB_ORIGIN1= account option. |
LEG1_CALL_ORIGINATION | varchar | 100 | This entry specifies the call origination (ANI/CLID) to be used when placing a call to the first leg of the callback and can be used to indicate the call is coming from a certain ANI/CLID. If this value is omitted the call will be placed with a blocked ANI/CLID. This entry is useful when you want to make the call look like it is originating from a certain, known or fixed caller. Acceptable values for this column are the same as the 'Call Origination' field of the Outbound Route. See Outbound Routes for more information. Note: This column overrides the CB_CALLBACK_CALL_ORIGINATION_LEG1 Module Setting and can be overridden by the CLID= account option. |
LEG1_DESTINATION | varchar | 40 | This is the destination number to be used to place a call to the first leg of the callback. If this column is empty the system will attempt to use the destination extracted from the DNIS, if one is not found it will try to use the account's CALLBACK_NUMBER setting and if that is blank it will reject the callback request. If this column is set to ANI the system will use the caller's incoming ANI as the destination for the leg 1 callback. Since the ANI may not be formatted to permit the system to dial it directly (e.g. 3105551212 may need to be set to 13105551212) you may need to perform some digit manipulations at the Outbound Route level or you may want to set SYS_PREFIX_MAP to 'YES' and e the PREFIX_MAP table to reformat the destination for rating and for routing. |
LEG1_LANGUAGE | varchar | 20 | This is the language that will be used when prompting the caller during leg 1 of the callback call (e.g. playing the balance, prompting for the destination number, playing error messages, etc.). Note: If the associated account has a language specified at the Account or Class of Service level it will override this column. |
LEG2_ORIGIN | varchar | 40 | The entry specifies the Origin that will be used during authorization and rating when placing a all to the second leg of the callback. By setting a different Origin you can cause the system to select a different Rate Schedule Item (and thus Rate Plan) as well as a different Rate Plan entry allowing different rates, billing increments, rating tiers to be charged between the two call legs. Note: This column overrides the CB_CALLBACK_ORIGIN_LEG1 setting and can be overridden by the CB_ORIGIN2= account option. |
LEG2_CALL_ORIGINATION | varchar | 100 | This entry specifies the call origination (ANI/CLID) to be used when placing a call to the second leg of the callback and can be used to indicate the call is coming from a certain ANI/CLID. If this value is omitted the call will be placed with a blocked ANI/CLID. This entry is useful when you want to make the call look like it is originating from a certain, known or fixed caller. Acceptable values for this column are the same as the 'Call Origination' field of the Outbound Route. See Outbound Routes for more information. Note: This column overrides the CB_CALLBACK_CALL_ORIGINATION_LEG1 Module Setting and can be overridden by the CLID= account option. |
LEG2_DESTINATION | varchar | 40 | This is the destination number to be used to place a call to the second leg of the callback. If this column is empty the system will prompt the caller during the callback for the desired destination number. If this column is set to ANI the system will use the caller's incoming ANI as the destination for the leg 1 callback. Since the ANI may not be formatted to permit the system to dial it directly (e.g. 3105551212 may need to be set to 13105551212) you may need to perform some digit manipulations at the Outbound Route level or you may want to set SYS_PREFIX_MAP to 'YES' and use the PREFIX map to reformat the destination for rating and for routing. |
LEG2_LANGUAGE | varchar | 20 | Reserved for future use. |
ALIAS | varchar | 40 | This is a unique alternate means to reference this entry in the CALLBACK table and is used for Click to Call type applications. If you leave this entry blank the system will automatically assign an ALIAS, otherwise it will use the unique entry you specify. |
EXPIRATION_DATE_TIME | smalldatetime | 4 | UTC date/time when this entry expires. |
ENABLED | bit | 1 | Specifies whether this entry is enabled or not. |
DESCRIPTION | varchar | 40 | Description of this entry. |