Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 7b4c9e8

Browse files
committedJun 7, 2017
Update IncomingPhoneNumbers API docs for the status callback feature
This close #2207
1 parent 946b6ca commit 7b4c9e8

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed
 

‎restcomm/restcomm.docs/sources-asciidoc/src/main/asciidoc/api/incoming-phone-numbers-api.adoc

+44
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,50 @@ You may specify one or more of the following parameters to update this phone num
100100
|AccountSid |The unique 34 character id of the account to which you wish to transfer this phone number.
101101
|==========================================================================================================================================================================================================================================================
102102

103+
[[attributes-status-callback]]
104+
==== statusCallback
105+
106+
With IncomingPhoneNumber **statusCallback**, you can subscribe to receive webhooks for different events on the incoming phone number.
107+
108+
The statusCallback events are:
109+
110+
* RINGING
111+
* IN_PROGRESS
112+
* COMPLETED
113+
114+
==== statusCallbackMethod
115+
116+
The *statusCallbackMethod* attribute allows you to specify which HTTP method Restcomm should use when requesting the URL in the statusCallback attribute. The default is POST.
117+
118+
==== Status Callback HTTP Parameters
119+
120+
The parameters Restcomm passes to your application in its asynchronous request to the StatusCallback URL include all parameters passed in a synchronous request to retrieve RCML when Restcomm receives a call to one of your Restcomm numbers. The full list of parameters and descriptions of each are in the RCML Voice Request documentation.
121+
122+
When the call progress events are fired, the Status Callback request also passes these additional parameters:
123+
124+
[cols=",",options="header",]
125+
|===================================================================================================================================================================================================================================================================
126+
|Parameter |Description
127+
|CallSid |A unique identifier for this call, generated by Restcomm. You can use the `CallSid` to modify the child call by POSTing to Calls/\{CallSid} with a new RCML URL.
128+
|InstanceId |A unique identifier for this Restcomm-Connect instance.
129+
|OutboundCallSid | **optional** - A unique identifier for the outbound leg of this call
130+
|AccountSid | A unique identifier of the account that this number belongs
131+
|From | A string that describes the From address
132+
|To | A string that describes the To address
133+
|CallStatus |A descriptive status for the call. The value is one of **`ringing`**, **`in-progress`**, **`completed`**.
134+
|ApiVersion | A string that describes the Restcomm-Connect REST API version
135+
|Direction | A string that describes the direction of the call
136+
|CallerName | **optional** A string that represents the callers name, if available
137+
|ForwardedFrom | **optiona** A string that represents the number that the call was forwarded from
138+
|CallTimestamp | A string the describe the timestamp of the call
139+
|ReferTarget | **optional** A string that describes the transfer target, if this call started by a transfer
140+
|Transferor | **optional** A string that describes the transferor, if this call started by a transfer
141+
|Transferee | **optional** A string that describes the transferee, if this call started by a transfer
142+
|DialSipCallId | **optional** The SIP Call-ID header value for final SIP Responses to the call
143+
|DialSipResponseCode | **optional** The SIP response code for final SIP Responses to the call
144+
|DialSipHeader_ | **optional** The SIP custome headers (if any) for final SIP Responses to the call
145+
|===================================================================================================================================================================================================================================================================
146+
103147
[[http-delete]]
104148
===== HTTP DELETE
105149

0 commit comments

Comments
 (0)
Please sign in to comment.