02.0 Dial
Initiate a new outbound call.
This method accepts an internal extension number and a number to dial. The system dials the internal extension and then connects the call to the dialled number.
Entry point:
https://<server host>/servicemanager/rest/CallManagementAPI/dialHTTP Method: POST
Content Type: application/x-www-form-urlencoded
Parameters:
Parameter | Description | Mandaotry | From Version |
number | the external number or extension to dial. Normally this is an external number. e.g. 0383208100 will dial the external no. 0383208100. | Yes |
|
extenOrUniqueId | the agent or internal extension to connect the call to. If you pass an extension no. it must include the tech: e.g. SIP/100 | Yes |
|
autoAnswer | the auto answer string for the internal extension. This string will vary by handset manufacturer, make and model. | No |
|
callerId | the caller ID for this outbound call. This is the ID reported to the receiver. When dialing via the API if a Caller ID is not set then the normal Caller ID logic will be applied (i.e. check Handset, Account, Trunk for Caller ID's). If a Caller ID is set then the Handset, Account and Trunk Caller ID's will be ignored however the Trunk and Trunk Group Caller ID rewrites will still be applied. | No |
|
phoneCaption | Allows and additional line of text to be displayed on the handset in additional to the number that was dialed. Note: this feature is highly handset dependant and may not work on handsets with very small LCDs. | No |
|
monitored | "yes" to receive events for this extension through subscribe. The default is "no". | No |
|
apiKey | api key provided by Noojee Support | Yes |
|
record | pass 'true' to have the system start recording when the call is answered. | No | 6.0.1.x |
tag | If the 'record' argument is passed then you may also pass a 'tag=value' argument. The 'value' component will be added to the recording as a 'tag' which is visible and searchable from the Recording Page in Noojee Contact. | No | 6.0.1.x |
Sample dial query:
https://<server host>/servicemanager/rest/CallManagementAPI/dial?
autoAnswer=&
callerId=&
phoneCaption=My+Brand&
number=0383208100&
extenOrUniqueId=SIP/101&
apiKey=f863246a-973e-11e6-8784-08002718f5b5
Sample success response:
{"SessionID":7,"Message":"Originate successfully queued","Code":0}