The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
CreateMeetingDialOut
Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the
CreateSipMediaApplicationCall
action with the corresponding SIP media application ID.
Important
This API is not available in a dedicated namespace.
Request Syntax
POST /meetings/meetingId
/dial-outs HTTP/1.1
Content-type: application/json
{
"FromPhoneNumber": "string
",
"JoinToken": "string
",
"ToPhoneNumber": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- meetingId
-
The Amazon Chime SDK meeting ID.
Pattern:
[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Required: Yes
Request Body
The request accepts the following data in JSON format.
- FromPhoneNumber
-
Phone number used as the caller ID when the remote party receives a call.
Type: String
Pattern:
^\+?[1-9]\d{1,14}$
Required: Yes
- JoinToken
-
Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9+/]+$
Required: Yes
- ToPhoneNumber
-
Phone number called when inviting someone to a meeting.
Type: String
Pattern:
^\+?[1-9]\d{1,14}$
Required: Yes
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"TransactionId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- TransactionId
-
Unique ID that tracks API calls.
Type: String
Pattern:
[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permissions to perform the requested operation.
HTTP Status Code: 403
- BadRequestException
-
The input parameters don't match the service's restrictions.
HTTP Status Code: 400
- ForbiddenException
-
The client is permanently forbidden from making the request.
HTTP Status Code: 403
- ResourceLimitExceededException
-
The request exceeds the resource limit.
HTTP Status Code: 400
- ServiceFailureException
-
The service encountered an unexpected error.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is currently unavailable.
HTTP Status Code: 503
- ThrottledClientException
-
The client exceeded its request rate limit.
HTTP Status Code: 429
- UnauthorizedClientException
-
The client is not currently authorized to make the request.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: