Own AWS? Customize your docs with AI search, analytics, and more.

POST

/meetings/{meetingId}/dial-outs

http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs

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 <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.

Access Token Required: API Key

Path Parameters

meetingIdstringrequired

The Amazon Chime SDK meeting ID.

Body Params

JoinTokenstringrequired

Token used by the Amazon Chime SDK attendee. Call the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> action to get a join token.

ToPhoneNumberstringrequired

Phone number called when inviting someone to a meeting.

FromPhoneNumberstringrequired

Phone number used as the caller ID when the remote party receives a call.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/meetings/{meetingId}/dial-outs

http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs

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 <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.

Access Token Required: API Key

Path Parameters

meetingIdstringrequired

The Amazon Chime SDK meeting ID.

Body Params

JoinTokenstringrequired

Token used by the Amazon Chime SDK attendee. Call the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> action to get a join token.

ToPhoneNumberstringrequired

Phone number called when inviting someone to a meeting.

FromPhoneNumberstringrequired

Phone number used as the caller ID when the remote party receives a call.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/meetings/{meetingId}/dial-outs

http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs

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 <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.

Access Token Required: API Key

Path Parameters

meetingIdstringrequired

The Amazon Chime SDK meeting ID.

Body Params

JoinTokenstringrequired

Token used by the Amazon Chime SDK attendee. Call the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> action to get a join token.

ToPhoneNumberstringrequired

Phone number called when inviting someone to a meeting.

FromPhoneNumberstringrequired

Phone number used as the caller ID when the remote party receives a call.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

/meetings/{meetingId}/dial-outs

http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs

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 <code>CreateSipMediaApplicationCall</code> action with the corresponding SIP media application ID.

Access Token Required: API Key

Path Parameters

meetingIdstringrequired

The Amazon Chime SDK meeting ID.

Body Params

JoinTokenstringrequired

Token used by the Amazon Chime SDK attendee. Call the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> action to get a join token.

ToPhoneNumberstringrequired

Phone number called when inviting someone to a meeting.

FromPhoneNumberstringrequired

Phone number used as the caller ID when the remote party receives a call.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://service.chime.aws.amazon.com/meetings/{meetingId}/dial-outs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}