Pular para o conteúdo

GET /v1/conversations/{id}/channels

GET
/v1/conversations/{id}/channels
curl --request GET \
--url https://seu-endereco-da-api/v1/conversations/example/channels \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler conversas (conversations:read).

id
required
string
Media typeapplication/json
object
items
required
Array<object>
object
name
required

O nome que o cliente deu ao canal na plataforma

string
provider
required
string
status
required
string
coexistence
required
boolean
phoneNumber
required

O numero ou @ da conta no provedor

string
nullable
accountName
required

O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite

string
nullable
removed
required

O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu

boolean
id
required
string
current
required
boolean
attachments
required

What this channel accepts per attachment kind; a kind outside the list is refused with 422 attachment_not_supported

object
audio
required
object
formats
required

Null: the channel takes whatever the platform lets through

Array<object>
nullable
object
extension
required

File extension as the channel’s documentation names it (pdf, m4a, jpeg)

string
mimes
required

MIME types that count as this format

Array<string>
maxBytes
required

The channel’s own size ceiling for this kind; null: only the platform upload limit applies

number
nullable
image
required
object
formats
required

Null: the channel takes whatever the platform lets through

Array<object>
nullable
object
extension
required

File extension as the channel’s documentation names it (pdf, m4a, jpeg)

string
mimes
required

MIME types that count as this format

Array<string>
maxBytes
required

The channel’s own size ceiling for this kind; null: only the platform upload limit applies

number
nullable
video
required
object
formats
required

Null: the channel takes whatever the platform lets through

Array<object>
nullable
object
extension
required

File extension as the channel’s documentation names it (pdf, m4a, jpeg)

string
mimes
required

MIME types that count as this format

Array<string>
maxBytes
required

The channel’s own size ceiling for this kind; null: only the platform upload limit applies

number
nullable
document
required
object
formats
required

Null: the channel takes whatever the platform lets through

Array<object>
nullable
object
extension
required

File extension as the channel’s documentation names it (pdf, m4a, jpeg)

string
mimes
required

MIME types that count as this format

Array<string>
maxBytes
required

The channel’s own size ceiling for this kind; null: only the platform upload limit applies

number
nullable
voiceNoteProfile
required

The format a recorded voice note is converted to before leaving on this channel

string
Allowed values: whatsapp-opus meta-aac

Example

{
"items": [
{
"attachments": {
"voiceNoteProfile": "whatsapp-opus"
}
}
]
}