Get Credentials for Join Voice Channel

Request

Path Params

teamId

string

required

channelId

string

required

Query Params

isMuted

boolean

optional

Example:

true

isDeafened

boolean

optional

Example:

false

Header Params

Authorization

string

required

Default:

Bot {token}

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.teamly.one/api/v1/teams//channels//join?isMuted=true&isDeafened=false' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

success

boolean

required

Indicates if the operation was successful.

userId

string

required

ID of the user initiating or involved in the meeting.

channelId

string

required

ID of the channel associated with the meeting.

meetingData

object

required

ExternalMeetingId

string

required

Unique external ID for the meeting.

MediaPlacement

object

required

MediaRegion

string

required

AWS region where the media is hosted.

MeetingArn

string

required

ARN of the meeting.

MeetingId

string

required

Unique ID of the meeting.

TenantIds

array[string]

required

List of tenant IDs associated with the meeting.

attendeeData

object

required

AttendeeId

string

required

Unique ID for the attendee.

Capabilities

object

required

ExternalUserId

string

required

External ID of the attendee user.

JoinToken

string

required

Token used by the attendee to join the meeting.

Example

{
  "isSuccess": true,
  "userId": "ab12cd34ef56gh78",
  "channelId": "98zy76wx54vu32ts",
  "meetingDetails": {
    "externalMeetingId": "123e4567-e89b-12d3-a456-426614174000",
    "mediaPlacement": {
      "audioFallbackUrl": "wss://example.aws:443/calls/abc12345-def6-7890-gh12-ijkl34567890",
      "audioHostUrl": "audio123.aws:3478",
      "eventIngestionUrl": "https://data.example.com/v1/client-events",
      "screenDataUrl": "wss://example.aws:443/v2/screen/abc12345-def6-7890-gh12-ijkl34567890",
      "screenSharingUrl": "wss://example.aws:443/v2/screen/abc12345-def6-7890-gh12-ijkl34567890",
      "screenViewingUrl": "wss://example.aws:443/ws/connect?passcode=examplePass&viewer_uuid=exampleUUID&X-BitHub-Call-Id=abc12345-def6-7890-gh12-ijkl34567890",
      "signalingUrl": "wss://signal.example.com/control/abc12345-def6-7890-gh12-ijkl34567890",
      "turnControlUrl": "https://turn.example.com/v2/turn_sessions"
    },
    "region": "eu-west-1",
    "meetingArn": "arn:aws:chime:eu-west-1:123456789012:meeting/abc12345-def6-7890-gh12-ijkl34567890",
    "meetingId": "abc12345-def6-7890-gh12-ijkl34567890",
    "tenantIds": []
  },
  "attendeeDetails": {
    "attendeeId": "xyz98765-4321-abcd-efgh-567890123456",
    "capabilities": {
      "audio": "SendReceive",
      "content": "SendReceive",
      "video": "SendReceive"
    },
    "externalUserId": "ab12cd34ef56gh78",
    "joinToken": "eHl6OTg3NjUtNDMyMS1hYmNkLWVmZ2gtNTY3ODkwMTIzNDU2OmFiYzEyMzQ1LTY3ODktYWJjZC1lZmdoLTU2Nzg5MDEyMzQ1Ng"
  }
}