Call Out a SIP Participant
Initiate a call to a SIP participant to join a meeting.
Only the host or a cohost of the meeting is allowed to invoke this API. If a user invoking the API is not a Service App, the user must join the meeting before invoking the API. If a user is a Service App, the service app can invoke the API without joining the meeting.
The authenticated user calling this API must have the meeting:participants_write scope.
The ringing on the invited SIP device stops in 30 seconds if there is no response.
Body Parameters
Unique identifier of the meeting to which the SIP participant is to be called out. Either meetingId or meetingNumber must be specified.
Number of the meeting to which the SIP participant is to be called out. Either meetingId or meetingNumber must be specified.
SIP address of the invited SIP participant.
Type of the address.
SIP address.
Phone number.
An internal ID that is associated with the call-out invitation. Only UUIDs with hyphens are supported. The letters in the UUID must be in lowercase. A random UUID will be generated automatically if not specified.
The display name of the invited SIP participant. The maximum length is 32 characters.
Response Properties
Participant ID. It can be used in the "Cancel Call Out a SIP Participant" API.
An internal ID that is associated with the call-out invitation.
Number of the meeting to which the SIP participant is to be called out.
Unique identifier of the meeting to which the SIP participant is to be called out.
SIP address of the invited SIP participant.
Type of the address.
SIP address.
Phone number.
The display name of the invited SIP participant.
The state of the invited SIP participant.
The invited SIP participant is waiting for approval. Participants in the pending state will not be listed by the "List Meeting Participants" API.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- Unique identifier of the meeting to which the SIP participant is to be called out. Either `meetingId` or `meetingNumber` must be specified.
- Number of the meeting to which the SIP participant is to be called out. Either `meetingId` or `meetingNumber` must be specified.
- SIP address of the invited SIP participant.
- Type of the `address`.
- An internal ID that is associated with the call-out invitation. Only UUIDs with hyphens are supported. The letters in the UUID must be in lowercase. A random UUID will be generated automatically if not specified.
- The display name of the invited SIP participant. The maximum length is 32 characters.
{
"meetingId": "d8c3347d7ec04242ba9b856184b334ac",
"address": "SIP:9053523155@examplezone.cisco.com",
"addressType": "sipAddress",
"invitationCorrelationId": "871ab255-64e6-4cd2-a5af-d33953898356",
"displayName": "Brenda DX80"
}
{
"participantId": "d8c3347d7ec04242ba9b856184b334ac_I_630641605678082408_57514861-50f7-3f5b-864f-ce0e308bf653",
"invitationCorrelationId": "871ab255-64e6-4cd2-a5af-d33953898356",
"meetingNumber": "79100342367",
"meetingId": "d8c3347d7ec04242ba9b856184b334ac",
"address": "SIP:9053523155@examplezone.cisco.com",
"addressType": "sipAddress",
"displayName": "Brenda DX80",
"state": "pending"
}