Chat
Retrieve a Chat
Get information about a chat by providing the chat ID.
Refer to the Chat object to find more details about the chat object
.
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token> is your apiKey
generated in Periskope API settings.
Headers
x-phone
string
requiredOrganisation phone number(with country code) and without any spaces or special characters.
e.g. 9190043XXXXX
Path Parameters
chat_id
string
requiredChat ID for which the action is to be performed
e.g.
For groups - 12054386805XXX@g.us
For individual chats - 9198765XXXXX@c.us
Response
200 - application/json
org_id
string
chat_id
string
members
object
is_muted
boolean
chat_name
string
chat_type
string
label_ids
object
org_phone
string
chat_image
string
created_at
string
updated_at
string
invite_link
string
is_archived
boolean
custom_properties
object
group_description
boolean
Was this page helpful?