Scribd Logo
Upload

Welcome to Scribd!

  • 798 views

    Whatsapp API Documentation

    Uploaded by

    Ilich Gonzalez UR
    The WhatsApp API documentation describes an API that allows sending and receiving messages through a WhatsApp account. It covers authorizing an account via QR code, sending different types of messages and files, managing chats and groups, and getting message delivery statuses. Settings like banning and webhooks are also explained.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd

    Whatsapp API Documentation

    Uploaded by

    Ilich Gonzalez UR
    798 views5 pages
    The WhatsApp API documentation describes an API that allows sending and receiving messages through a WhatsApp account. It covers authorizing an account via QR code, sending different types of messages and files, managing chats and groups, and getting message delivery statuses. Settings like banning and webhooks are also explained.

    Original Description:

    material

    Copyright

    © © All Rights Reserved

    Available Formats

    DOCX, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    The WhatsApp API documentation describes an API that allows sending and receiving messages through a WhatsApp account. It covers authorizing an account via QR code, sending different types of messages and files, managing chats and groups, and getting message delivery statuses. Settings like banning and webhooks are also explained.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd
    Download as docx, pdf, or txt
    798 views5 pages

    Whatsapp API Documentation

    Uploaded by

    Ilich Gonzalez UR
    The WhatsApp API documentation describes an API that allows sending and receiving messages through a WhatsApp account. It covers authorizing an account via QR code, sending different types of messages and files, managing chats and groups, and getting message delivery statuses. Settings like banning and webhooks are also explained.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd
    Download as docx, pdf, or txt
    of 5

    Whatsapp API documentation

    1.0.0
    OAS3

    https://app.chat-api.com/swagger.json
    The REST API allows you to receive and send messages through your WhatsApp
    account. Sign up now

    Parameters in GET queries pass query string. Parameters in POST requests — through the
    JSON-encoded request body. The authorization token is always passed to query string
    (?token=xxxxxx).

    The WhatsApp API is based on the WhatsApp WEB protocol and excludes the ban both when
    using libraries from mgp25 and the like. Despite this, your account can be banned by anti-
    spam system WhatsApp after several clicking the "block" button.

    Contact the developer


    Servers

    Computed URL:https://api.chat-api.com/instance123

    Server variables

    instanceId 123

    protocol

    Authorize

    instance
    Manage instance
    GET/status
    Get the account status and QR code for authorization.

    GET/qr_code
    Direct link to QR-code in the form of an image, not base64.

    POST/logout
    Logout from WhatsApp Web to get new QR code.

    POST/takeover
    Returns the active session if the device has connected another instance of Web WhatsApp

    POST/expiry
    Updates the QR code after its expired
    POST/retry
    Repeat the manual synchronization attempt with the device

    POST/reboot
    Reboot your whatsapp instance.

    GET/settings
    Get settings

    POST/settings
    Set settings

    messages
    Send and receive messages
    POST/sendMessage
    Send a message to a new or existing chat.

    POST/sendFile
    Send a file to a new or existing chat.

    POST/sendPTT
    Send a ptt-audio to a new or existing chat.

    POST/sendLink
    Send text with link and link's preview to a new or existing chat.

    POST/sendContact
    Sending a contact or contact list to a new or existing chat.

    POST/sendLocation
    Sending a location to a new or existing chat.

    POST/sendVCard
    Sending a vcard to a new or existing chat.

    POST/forwardMessage
    Forwarding messages to a new or existing chat.

    GET/messages
    Get a list of messages.

    chats
    Manage chats and group
    GET/dialogs
    Get the chat list.

    POST/group
    Creates a group and sends the message to the created group.

    POST/addGroupParticipant
    Adding participant to a group
    POST/removeGroupParticipant
    Remove participant from a group

    POST/promoteGroupParticipant
    Make participant in the group an administrator

    POST/demoteGroupParticipant
    Demote group participant

    POST/readChat
    Open chat for reading messages

    webhooks
    API responses
    POST/webhook
    Sets the URL for receiving webhook

    queues
    Manage queues
    GET/showMessagesQueue
    Get outbound messages queue.

    POST/clearMessagesQueue
    Clear outbound messages queue.

    GET/showActionsQueue
    Get outbound messages queue.

    POST/clearActionsQueue
    Clear outbound actions queue.

    ban
    Manage ban settings
    GET/banSettings
    Get settings

    POST/banSettings
    Set settings

    POST/banTest
    Test ban settings

    testing
    Testing instance
    GET/instanceStatuses
    Returns instance status changes history.

    GET/webhookStatus
    Returns webhook status for message.
    Schemas
    InstanceStatus
    InstanceStatusAction
    InstanceStatusLink
    Settings
    BanSettings
    SendMessageStatus
    SetWebhookStatus
    CreateGroupStatus
    GroupParticipantStatus
    ReadChatStatus
    ClearMessagesQueueStatus
    ClearActionsQueueStatus
    BanTestStatus
    Messages
    Message
    Ack
    ChatUpdate
    Chats
    Chat
    OutboundMessages
    OutboundMessage
    OutboundActions
    OutboundAction
    SendMessageRequest
    SendFileRequest
    SendPTTRequest
    SendLinkRequest
    SendContactRequest
    SendLocationRequest
    SendVCardRequest
    ForwardMessageRequest
    WebhookUrl
    CreateGroupAction
    GroupParticipantAction
    ReadChatAction
    BanTestAction
    ChatIdProp
    PhoneProp
    Statuses
    Status
    WebhookStatus

    You might also like