{"info":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","description":"\"2chat.co\"\n\n

2Chat is an automation layer built on top of WhatsApp and other text channels. This API powers that service and is available to developers like you to build upon.

\n

📌 Before you begin

\n

Clone this collection into Postman's desktop application to run it as doing it from a browser may cause CORS errors.

\n

👶 Create an account

\n

You will need a 2Chat account and a connected number to be able to use this API. You can do so here.

\n

🔒 Authentication

\n

We enforce HTTP-header-based API-key authentication on the endpoints that provide functionality, like for sending and receiving messages.

\n

Your API Key can be obtained after signing up for the service and renewed/changed at any time.

\n

For more information about how to get your API key, check this article from our help center.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderValueDescription
X-User-API-Keymy_api_key_valueYour API Key
\n

Environment configuration

\n

Configure the API key you got in the previous step inside the 2Chat environment. If it doesn't exist you, can create it.

\n\"Configuring%20the%20API%20key\"\n\n

Extra environment variables

\n

You will also need to configure the phone number (CONNECTED_NUMBER variable) you have connected to 2Chat.

\n\"Configuring%20the%20collection%20variables\"\n\n

You can leave the WHATSAPP_GROUP_UUID unassigned until you want to test the WhatsApp group-related endpoints.

\n

⚠️ Authentication error response

\n

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

\n

Likewise, if your account expires, HTTP 402 Payment required will arrive as an answer.

\n

💨 Rate and usage limits

\n

API access rate limits apply on a per-API key basis per unit of time. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

\n

To prevent abuse, trial accounts are limited to 10 requests per minute which is 1 request every 6 seconds. To remove this restriction, please consider upgrading your account.

\n

❌ 503 response

\n

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next few minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

\n

📙 Need some help?

\n

Please check out our Developers Portal and Help Center.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20444184","collectionId":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","publishedId":"2s946h9YKd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-07-18T15:35:23.000Z"},"item":[{"name":"✅ Check if your API key works","item":[{"name":"Get account information","event":[{"listen":"test","script":{"id":"655ee05e-0c82-4add-a380-b9cfaa091e4b","exec":[""],"type":"text/javascript"}}],"id":"2fd0e781-263c-403a-9eba-17d2ea867eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.p.2chat.io/open/info/","description":"

Gets information about the authenticated user.

\n","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","info",""],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"a18bc9a3-2ab8-4dcb-a3f0-9ee2e2194af3","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.p.2chat.io/open/info/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"account\": {\n \"name\": \"My Test Account\",\n \"uuid\": \"ACC91be87af-5a29-4034-b599-342f2aeb5d52\",\n \"on_trial\": true,\n \"blocked\": false,\n \"block_reason\": null,\n \"created_at\": \"2022-04-21T21:55:37Z\",\n \"expires_at\": \"2023-08-14T15:32:21Z\"\n },\n \"limits\": {\n \"requests_per_minute\": 10\n }\n}"}],"_postman_id":"2fd0e781-263c-403a-9eba-17d2ea867eac"}],"id":"dee3f61b-2b3f-4c52-9699-e9dff8440a4d","description":"

The /info endpoint will return your account's status together with its limits.

\n","_postman_id":"dee3f61b-2b3f-4c52-9699-e9dff8440a4d","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}}},{"name":"💬 WhatsApp Messenger & WhatsApp Business","item":[{"name":"Webhooks","item":[{"name":"List all webhooks","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"afd2791f-4cfc-456b-a476-d13e576686a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/webhooks","description":"

This endpoint will return all configured and enabled webhooks you have in your 2Chat account.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescriptionExample values
uuidThe unique identifier of the webhook that you will need to make changes to itWHKdc78c87e-5b18-47c7-9183-5bf527fd6c69
event_nameThe name of the event this webhook is subscribed towhatsapp.call.received.
channel_uuidThe unique UUID of the channel this webhook is subscribed toWPN95841312-b54d-46e3-b0bc-6414f4a5296b
hook_urlThe URL 2Chat will call when a event is triggeredhttps://my-dev-server
hook_paramsCustom parameters 2Chat sets to make the webhook functional{}
created_atUTC timestamp for when the webhook was created2023-04-17T18:50:45Z
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","webhooks"],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"4b0ee860-17e5-4155-a367-597143fdc652","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"webhooks\": [\n {\n \"uuid\": \"WHKdc78c87e-5b18-47c7-9183-5bf527fd6c69\",\n \"event_name\": \"whatsapp.message.received\",\n \"channel_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\",\n \"hook_url\": \"https://www.toptal.com/developers/postbin/1681755466939-3421728690154\",\n \"hook_params\": {\n \"waweb_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\"\n },\n \"created_at\": \"2023-04-17T18:50:50Z\"\n },\n {\n \"uuid\": \"WHKe768c62c-d41f-49a9-82ff-8982a0683902\",\n \"event_name\": \"whatsapp.message.sent\",\n \"channel_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\",\n \"hook_url\": \"https://www.toptal.com/developers/postbin/1681755466939-3421728690154\",\n \"hook_params\": {\n \"waweb_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\"\n },\n \"created_at\": \"2023-04-17T18:50:45Z\"\n }\n ]\n}"}],"_postman_id":"afd2791f-4cfc-456b-a476-d13e576686a1"},{"name":"Subscribe to webhook","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"7b669a2f-c3ec-4582-9e35-8ccac34007f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hook_url\": \"https://www.toptal.com/developers/postbin/1681755466939-3421728690154\",\n \"on_number\": \"+595981048477\"\n}"},"url":"https://api.p.2chat.io/open/webhooks/subscribe/{{WEBHOOK_NAME}}","description":"

Posting a request to this endpoint will create a new webhook subscription to the specified event.

\n

List of accepted events

\n

Any of these events can be specified as a query parameter in the invocation URL.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EventDescription
whatsapp.call.receivedTriggers when a new WhatsApp call is received and missed
whatsapp.message.newTriggers when a new WhatsApp message is either sent or received
whatsapp.message.receivedTriggers when a new WhatsApp message is received
whatsapp.message.sentTriggers when a new WhatsApp message is sent
whatsapp.conversation.newTriggers when a new WhatsApp conversation is started
whatsapp.audio.transcribedTriggers when a new WhatsApp audio message is transcribed to text
\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
EventDescription
whatsapp.group.message.receivedTriggers when a message is received on a WhatsApp group your number is part of
whatsapp.group.joinTriggers when someone joins a group
whatsapp.group.leaveTriggers when some leaves a group
whatsapp.group.removeTriggers when someone is kicked/removed from a group
\n

Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
hook_urlA valid and publicly reachable URL that 2Chat will invoke when the event is triggered
on_numberThe phone number that you have configured and connected to 2Chat. Always make sure it is connected
time_periodRequired only if you are subscribing to whatsapp.conversation.new.
\n

For the whatsapp.conversation.new event, you can specify also the time period of your preference to consider a conversation new.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Time Period ValueDescription
all-timeWill trigger the new conversation event when the user messages you for the first time ever. This is the default value when no time period is specified
hourWill trigger the new conversation event after 1 hour of no messages
dayWill trigger the new conversation event after 1 day of no messages
weekWill trigger the new conversation event after 1 week of no messages
monthWill trigger the new conversation event after 1 month of no messages
yearWill trigger the new conversation event after 1 year of no messages
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","webhooks","subscribe","{{WEBHOOK_NAME}}"],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"20be28f1-9201-4d36-8fa2-5840d3d3c363","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hook_url\": \"https://www.toptal.com/developers/postbin/1681755466939-3421728690154\",\n \"on_number\": \"+595981048477\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.p.2chat.io/open/webhooks/subscribe/{{WEBHOOK_NAME}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"uuid\": \"WHK530c9d58-2259-4ce2-82a8-1941f3a60665\",\n \"event_name\": \"whatsapp.message.sent\",\n \"channel_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\",\n \"hook_url\": \"https://www.toptal.com/developers/postbin/1681755466939-3421728690154\",\n \"hook_params\": {\n \"waweb_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\"\n },\n \"created_at\": \"2023-04-18T01:58:02Z\"\n }\n}"}],"_postman_id":"7b669a2f-c3ec-4582-9e35-8ccac34007f6"},{"name":"Delete webhook subscription","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"a6c176a7-90fa-4790-9117-0b961b99a5e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/webhooks/{{WEBHOOK_UUID}}","description":"

With this endpoint, you will be able to delete webhooks you have previously created using this API.

\n

Requirements

\n

The query path in the invocation URL must have the ID of the webhook you want to delete. This ID always starts with WHK followed by 36 characters. For example: WHK530c9d58-2259-4ce2-82a8-1941f3a60665.

\n

If you want to obtain the ID required to delete a webhook, you can do so using the List All Webhooks endpoint.

\n","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","webhooks","{{WEBHOOK_UUID}}"],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"160bf791-693c-4893-a9c4-a9eaab237c41","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"collection\": {\n \"info\": {\n \"name\": \"Test Collection\",\n \"description\": \"This collection makes a request to the Postman Echo service to get a list of request headers sent by an HTTP client.\",\n \"schema\": \"https://schema.getpostman.com/json/collection/v2.1.0/collection.json\"\n },\n \"item\": [\n {\n \"name\": \"Test GET Response\",\n \"event\": [\n {\n \"listen\": \"test\",\n \"script\": {\n \"id\": \"7d2334fc-a84a-4c3d-b26c-7529afa4c0ae\",\n \"exec\": [\n \"pm.test(\\\"Status code is 200\\\", function () {\",\n \" pm.response.to.have.status(200);\",\n \"});\"\n ],\n \"type\": \"text/javascript\"\n }\n }\n ],\n \"request\": {\n \"url\": \"https://echo.getpostman.com/headers\",\n \"method\": \"GET\",\n \"header\": [\n {\n \"key\": \"Content-Type\",\n \"value\": \"application/json\"\n }\n ]\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.p.2chat.io/open/webhooks/{{WEBHOOK_UUID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"}],"_postman_id":"a6c176a7-90fa-4790-9117-0b961b99a5e9"}],"id":"6b1b6e71-32b2-4079-b745-fe38e88557c3","description":"

This endpoint will help you create and manage webhooks to be able to know in real time when WhatsApp messages are sent or received.

\n","_postman_id":"6b1b6e71-32b2-4079-b745-fe38e88557c3","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}}},{"name":"List numbers","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"5b858aba-2e28-4723-8bd0-93f126eb8917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/get-numbers","description":"

This endpoint will help you list the numbers you have connected to 2Chat.

\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescriptionExample values
uuidThe unique identifier of the numberWPN95841312-b54d-46e3-b0bc-6414f4a5296b
friendly_namethe friendly name you chose for your numbermy number.
phone_numberthe phone number in international format+595981048477
iso_country_codethe two-letter country code of the numberUS
pushnamethe nickname you chose on WhatsAppMy business
serverWhatsApp-specific value595981048477@c.us
platformThe mobile device your WhatsApp app is running onandroid
connection_status2Chat value indicating the connection status to WhatsAppC = connected, D = disconnected, F = failure
enabledWhether the number is enabled or not on 2Chattrue
is_business_profileWhether the number is on Regular WhatsApp or WhatsApp for Businessfalse
channel_typeThe type of channelWW = WhatsApp Web, IG = Instagram, SMS = Phone Text Messages.
sync_contactsWhether you have enabled importing your phone directory to 2Chattrue
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","whatsapp","get-numbers"],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"6fd319df-7f19-486c-a94a-b3ab8695a0ab","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/get-numbers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"numbers\": [\n {\n \"uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\",\n \"friendly_name\": \"my testing number\",\n \"phone_number\": \"+595981048477\",\n \"iso_country_code\": \"PY\",\n \"pushname\": \"✌️\",\n \"server\": \"595981048477@c.us\",\n \"platform\": \"iphone\",\n \"connection_status\": \"C\",\n \"enabled\": true,\n \"is_business_profile\": false,\n \"channel_type\": \"WW\",\n \"sync_contacts\": true,\n \"created_at\": \"2022-10-31 22:05:44\",\n \"updated_at\": \"2022-12-01 21:40:04\"\n }\n ]\n}"}],"_postman_id":"5b858aba-2e28-4723-8bd0-93f126eb8917"},{"name":"List groups","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"250000a1-7043-4f12-b80a-f41304c7321e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/groups/","description":"

Using a 2Chat-connected number as the source, this endpoint will get you a list of all groups such number is a participant of.

\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescriptionExample value
uuidThe unique identifier of the groupWAG768beeef-2b96-4bc7-9b7f-045078568723
channel_uuidThe unique identifier of the channelWPN95841312-b54d-46e3-b0bc-6414f4a5296b
wa_group_idWhatsApp's internal identifier for the group...@g.us
profile_pic_urlURL to the profile picture of the grouphttps://...
wa_owner_idWhatsApp's internal identifier for the owner of the group17137157533@c.us
wa_group_nameName of the group2chat test group 👌
wa_created_atThe date the group was created at2022-10-23T17:11:41Z
wa_subjectSubject of the groupdaily motivational quotes 💪
sizeThe number of participants in this group4
is_mutedWhether the group is muted on your phonefalse
is_read_onlyWhether the group is read-only or notfalse
channel_is_ownerWhether you own the group or notfalse
created_atTimestamp of when the group was registered on 2Chat2023-06-22T20:02:56Z
updated_atThe last time 2Chat pulled information about the group2023-07-12T19:18:41Z
owner_contactThe contact information of the owner of the group, if presenttrue
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","whatsapp","groups",""],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"4a0f38c9-2136-4ff2-b5e7-6684fbc56e3c","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://api.p.2chat.io/open/whatsapp/groups/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n {\n \"success\": true,\n \"data\": [\n {\n \"uuid\": \"WAG768beeef-2b96-4bc7-9b7f-045078568723\",\n \"channel_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\",\n \"wa_group_id\": \"....@g.us\",\n \"profile_pic_url\": \"...\",\n \"wa_owner_id\": \"17137157533@c.us\",\n \"wa_group_name\": \"2chat test group 👌\",\n \"wa_created_at\": \"2022-10-23T17:11:41Z\",\n \"wa_subject\": \"daily motivational quotes 💪\",\n \"size\": 4,\n \"is_muted\": false,\n \"is_read_only\": false,\n \"channel_is_owner\": false,\n \"created_at\": \"2023-06-22T20:02:56Z\",\n \"updated_at\": \"2023-07-12T19:18:41Z\",\n \"owner_contact\": {\n \"uuid\": \"CON1653490d-194b-4992-8353-e4b46a64e321\",\n \"first_name\": \"Mikey\",\n \"last_name\": \"Mike\",\n \"channel_uuid\": \"WPNc568c832-606c-4d50-8092-fc51b5149d16\",\n \"profile_pic_url\": \"...\"\n }\n }\n ]\n }\n}"}],"_postman_id":"250000a1-7043-4f12-b80a-f41304c7321e"},{"name":"List group participants","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"1eee134e-84fb-4e45-b93b-cc207fae71c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/group/","description":"

Get all participants of a WhatsApp group.

\n

You need the UUID of the group to pull this information. You can get it from the List WhatsApp Groups endpoint.

\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescriptionExample value
owner_dataInformation about the owner of the group, including their phone number
participant.wa_participant_idWhatsApp's internal identifier for the participant595981048477@c.us
participant.wa_pushnamePush name or Notify name of the participantMikey
participant.profile_pic_urlURL to the profile picture of the partcipanthttps://
participant.wa_is_super_adminWhether the participant owns the group or nottrue
participant.wa_is_adminWhether the participant is an administrator in group or notfalse
participant.deviceThe participant last known deviceAny of android, ios, or web
participant.phone_numberThe phone number of the participant+595981048477
participant.iso_country_codeThe country code the phone number belongs toPY
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","whatsapp","group",""],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"156a5b51-d933-44a2-b44e-5883baac3158","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/group/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"uuid\": \"WGP768beeef-2b96-4bc7-9b7f-045078568723\",\n \"channel_uuid\": \"WPN95841312-b54d-46e3-b0bc-6414f4a5296b\",\n \"wa_group_id\": \"...@g.us\",\n \"profile_pic_url\": \"...\",\n \"wa_owner_id\": \"5215530483303@c.us\",\n \"wa_group_name\": \"2chat test group 👌\",\n \"wa_created_at\": \"2022-10-23T17:11:41Z\",\n \"wa_subject\": \"daily motivational quotes 💪\",\n \"size\": 3,\n \"is_muted\": false,\n \"is_read_only\": false,\n \"channel_is_owner\": false,\n \"created_at\": \"2023-06-22T20:02:56Z\",\n \"updated_at\": \"2023-07-12T19:18:41Z\",\n \"owner_contact\": {\n \"uuid\": \"CON1653490d-194b-4992-8353-e4b46a64e321\",\n \"first_name\": \"Mikey\",\n \"last_name\": \"Mike\",\n \"channel_uuid\": \"WPNc568c832-606c-4d50-8092-fc51b5149d16\",\n \"profile_pic_url\": \"...\"\n },\n \"owner_data\": {\n \"phone_number\": \"...\",\n \"formatted_phone_number\": \"...\",\n \"iso_country_code\": \"MX\"\n },\n \"participants\": [\n {\n \"wa_participant_id\": \"447700176576@c.us\",\n \"wa_pushname\": \"Carlos @ 2Chat\",\n \"profile_pic_url\": \"...\",\n \"wa_is_super_admin\": false,\n \"wa_is_admin\": false,\n \"device\": \"ios\",\n \"created_at\": \"2023-07-11T19:21:45Z\",\n \"updated_at\": \"2023-07-12T19:18:41Z\",\n \"contact\": {\n \"uuid\": \"CON767f3ab9-e2c1-48e0-9234-092e835fa089\",\n \"first_name\": \"2Chat\",\n \"last_name\": \"UK\",\n \"channel_uuid\": null,\n \"profile_pic_url\": null\n },\n \"phone_number\": \"+447700176576\",\n \"formatted_phone_number\": \"+44 7700 176576\",\n \"iso_country_code\": \"GB\"\n },\n {\n \"wa_participant_id\": \"5215617554529@c.us\",\n \"wa_pushname\": \"Mikey\",\n \"profile_pic_url\": \"...\",\n \"wa_is_super_admin\": false,\n \"wa_is_admin\": false,\n \"device\": null,\n \"created_at\": \"2023-07-11T19:30:03Z\",\n \"updated_at\": \"2023-07-12T19:18:41Z\",\n \"phone_number\": \"+525617554529\",\n \"formatted_phone_number\": \"+52 56 1755 4529\",\n \"iso_country_code\": \"MX\"\n },\n {\n \"wa_participant_id\": \"595981048477@c.us\",\n \"wa_pushname\": null,\n \"profile_pic_url\": null,\n \"wa_is_super_admin\": false,\n \"wa_is_admin\": true,\n \"device\": null,\n \"created_at\": \"2023-06-23T19:43:31Z\",\n \"updated_at\": \"2023-07-12T19:18:40Z\",\n \"contact\": {\n \"uuid\": \"CON36b2bc38-c21a-4712-8015-99bf2f8001f6\",\n \"first_name\": \"2Chat\",\n \"last_name\": \"PAR\",\n \"channel_uuid\": \"WPNc568c832-606c-4d50-8092-fc51b5149d16\",\n \"profile_pic_url\": null\n },\n \"phone_number\": \"+595981048477\",\n \"formatted_phone_number\": \"+595 981 048477\",\n \"iso_country_code\": \"PY\"\n }\n ]\n }\n}"}],"_postman_id":"1eee134e-84fb-4e45-b93b-cc207fae71c5"},{"name":"Check number","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"d7b913d9-550b-45d5-b5e2-3f2d937ac01c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/check-number//+17137157533","description":"

Using this endpoint you can check if a given number is registered on WhatsApp or not. This can be useful to know if you can use WhatsApp to send messages to a contact number.

\n

For a working client of this endpoint, check out our example script on GitHub.

\n

Parameters

\n

These are query-string parameters that should go on the URL you use to invoke the endpoint.
Considering https://api.p.2chat.io/open/whatsapp/check-number//:

\n
    \n
  • must be replaced with the actual WhatsApp number that you connected to 2Chat, and...
    • \n
  • with the number you want to know if WhatsApp is enabled or not.
    Example: https://api.p.2chat.io/open/whatsapp/check-number/+595981048477/+17137157533.
    • \n
\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
is_validWhether the number is syntactically valid or not
number.iso_country_codeTwo-letter country code of the number
number.regionThe approximate region the number belongs to
number.carrierThe first carrier (phone provider) that issued this number
number.timezoneThe timezone this number is likely on based on its region
on_whatsapptrue when the number is using WhatsApp
whatsapp_info.is_businesstrue when the number is a Business Account and has its profile public
whatsapp_info.is_enterprisetrue when the number has an Enterprise Account
whatsapp_info.profile_picURL of the public (not hidden from people who aren't contacts) profile picture if it has any
whatsapp_info.verified_level0 to 2. Where 0 is not verified and 2 is verified with the green badge
whatsapp_info.verified_nameThe business name of a verified account
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","whatsapp","check-number","","+17137157533"],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"217d7898-d2da-4422-8105-31be38ab829a","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/check-number//+17137157533"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"is_valid\": true,\n \"number\": {\n \"iso_country_code\": \"US\",\n \"region\": \"Texas\",\n \"carrier\": \"\",\n \"timezone\": [\n \"America/Chicago\"\n ]\n },\n \"on_whatsapp\": true,\n \"whatsapp_info\": {\n \"is_business\": true,\n \"is_enterprise\": true,\n \"profile_pic\": \"https://2chat-user-data-...\",\n \"verified_level\": 2,\n \"verified_name\": \"...\"}\n }\n}"}],"_postman_id":"d7b913d9-550b-45d5-b5e2-3f2d937ac01c"},{"name":"Get messages","event":[{"listen":"test","script":{"id":"d699c28f-b4d0-45ec-8902-0cc1b1129fd1","exec":[""],"type":"text/javascript"}}],"id":"4b47e9d8-7083-4a2e-a101-cf4bdd497786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/messages/","description":"

This endpoint will let you get messages that you received on your 2Chat-connected WhatsApp number. Only messages that you received after you made the connection to 2Chat will appear here.

\n

Parameters

\n

These are query-string parameters that should go on the URL you use to invoke the endpoint.

\n

Considering https://api.p.2chat.io/open/whatsapp/messages//, must be replaced with your actual WhatsApp number connected to 2Chat.

\n

Example: https://api.p.2chat.io/open/whatsapp/messages/+595981048477/.

\n

Response

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescription
uuidThe unique identifier of the message
timestampTimestamp of the message in UTC
session_keyThe chat session key that corresponds to this message
messageThe payload of the message
message.textThe text content of the message, if present
message.media.urlThe 2Chat-hosted media file URL sent or received
message.media.typeThe type of media message
message.media.mime_typeThe MIME type of the message
remote_phone_numberThe WhatsApp phone number of the other end of the conversation
sent_byWho sent the message. E.g.: api, agent, user
\n
","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","whatsapp","messages",""],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"af1ba5f8-79da-4cd5-8f00-3fc539bdf66b","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://api.p.2chat.io/open/whatsapp/messages/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"uuid\": \"MSGaf1fa3a1-0d8d-4aa5-b117-f9425b651485\",\n \"timestamp\": 1670454681.0,\n \"session_key\": \"WW-WPN95841312-b54d-46e3-b0bc-6414f4a5296b-5215512345432@c.us\",\n \"message\": {\n \"media\": {\n \"url\": \"https://2chat-user-data-dev.s3.amazonaws.com/ACC91be87af-5a29-4034-b599-342f2aeb5d52/accm/sfe4d7e29cd9dfad63b535dec54c5992055498dcd13cfc319f723c4b962b8803a.svg\",\n \"type\": \"image\",\n \"mime_type\": \"image/svg+xml\"\n }\n },\n \"remote_phone_number\": \"+5215512345432\",\n \"sent_by\": \"api\"\n },\n {\n \"uuid\": \"MSG8c39a0a9-01cf-46c9-ab46-3c0fb0477e99\",\n \"timestamp\": 1670378997.0,\n \"session_key\": \"WW-WPN95841312-b54d-46e3-b0bc-6414f4a5296b-5215512345432@c.us\",\n \"message\": {\n \"text\": \"you can see my replies here\"\n },\n \"remote_phone_number\": \"+5215512345432\",\n \"sent_by\": \"agent\"\n }\n ]\n\n}"}],"_postman_id":"4b47e9d8-7083-4a2e-a101-cf4bdd497786"},{"name":"Send message","event":[{"listen":"test","script":{"id":"9aa3fa6a-e2dc-4afe-97b4-906528cbb829","exec":[""],"type":"text/javascript"}}],"id":"4f14eb65-912f-4e2d-b964-b0e50a8de869","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"to_number\": \"+17137157133\",\n \"from_number\": \"\",\n \"text\": \"Test from 2Chat API using _Postman_\",\n \"url\": \"https://uploads-ssl.webflow.com/6281a9c52303343ff7c3b269/62a1648ee0273340bf38e3a9_logo-2C.svg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.p.2chat.io/open/whatsapp/send-message","description":"

This endpoint will let you send messages to any WhatsApp-enabled phone number using your own number connected to 2Chat.

\n

You can send text and multimedia messages, including audio, video, PDFs, images, etc., both to a single person or to a WhatsApp group.

\n
\n

💡 Trial accounts are rate-limited to 10 requests per minute (1 request every 6 seconds). If you would like a faster throughput, <em>please upgrade your account</em>.

\n
\n
\n

💡 If you are sending attachments using the _url_ field, make sure the attachment is publicly accessible and is not larger than 16 MB__.
If you are using Google Drive or you are not sure if the URL is publicly accessible, download it and reupload it to 2Chat to make sure it is. <em>Learn how here</em>.

\n
\n

Parameters

\n

These parameters should be sent as JSON payload in the request body.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldDescriptionExample values
from_numberThe number you have connected to 2Chat+595981048477
to_numberThe destination number you want to receive your message+5215512345432
to_group_uuidThe WhatsApp group UUID if you intend to send it to a groupWGP768beeef-2b96-4bc7-9b7f-045078568723
textThe content of the message you want to sendTest from 2Chat API
urlThe URL of the media file you want to attach to the message. This value is optional
\n

You can't use to_number and to_group_uuid in the same request. Learn more about where to get the group's UUID here.

\n","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}},"urlObject":{"protocol":"https","path":["open","whatsapp","send-message"],"host":["api","p","2chat","io"],"query":[],"variable":[]}},"response":[{"id":"ac514724-b4da-4647-9838-68762e714f5e","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"to_number\": \"+17137157133\",\n \"from_number\": \"\",\n \"text\": \"Test from 2Chat API using _Postman_\",\n \"url\": \"https://uploads-ssl.webflow.com/6281a9c52303343ff7c3b269/62a1648ee0273340bf38e3a9_logo-2C.svg\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.p.2chat.io/open/whatsapp/send-message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":{"content":"","type":"text/plain"}}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"batched\": true\n}"}],"_postman_id":"4f14eb65-912f-4e2d-b964-b0e50a8de869"}],"id":"f0c9331f-176a-4098-a4e8-cd4fe5eaa55b","description":"

This set of endpoints can be used to automate WhatsApp interactions programmatically.

\n

You will need:

\n
    \n
  1. A regular WhatsApp or a WhatsApp Business account. WhatsApp Business API is not required.
    2. \n
  2. A working 2Chat account where you have connected your WhatsApp account.
    3. \n
\n","_postman_id":"f0c9331f-176a-4098-a4e8-cd4fe5eaa55b","auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""},"isInherited":true,"source":{"_postman_id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","id":"dd0d0d67-ce3b-42ae-8073-68e7393a0422","name":"🚀 Programmable WhatsApp API by 2Chat","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"value":"{{API_KEY_VALUE}}","key":""}},"event":[{"listen":"prerequest","script":{"id":"374b555d-34b9-4aaa-b62f-01f91620042e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6a8b4234-2710-4bfa-8971-4e2f3446e9c1","type":"text/javascript","exec":[""]}}],"variable":[{"key":"CONNECTED_NUMBER","value":"","type":"string"},{"key":"WHATSAPP_GROUP_UUID","value":"","type":"string"}]}