{ "info": { "name": "GetReply API", "description": "GetReply API v1. Set the apiKey variable to your key. Requests sent here are real and charged like any other.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.getreply.in" }, { "key": "apiKey", "value": "gr_live_…" } ], "item": [ { "name": "Account", "item": [ { "name": "Your account", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/account", "host": [ "{{baseUrl}}" ], "path": [ "v1", "account" ] }, "description": "The business name, the plan and when it ends (India date), and the wallet.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Your WhatsApp number", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "number" ] }, "description": "Your WhatsApp number: display name, quality, daily messaging limit and whether it can send now.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Check your key", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/ping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ping" ] }, "description": "Answers when the key works. Use it to test your setup.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Message prices", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/prices", "host": [ "{{baseUrl}}" ], "path": [ "v1", "prices" ], "query": [ { "key": "country", "value": "", "disabled": true }, { "key": "category", "value": "", "disabled": true } ] }, "description": "The price of one message in rupees, by country and category — the same prices as in the app. Filter by country, category or both.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Today's usage", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ] }, "description": "People messaged in the last 24 hours, your daily limit and what is left. The limit counts people, not messages.\n\nPermission: Any key (Full, Send only or Read only)." } } ] }, { "name": "Contacts", "item": [ { "name": "List saved audiences", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/audiences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audiences" ] }, "description": "Your saved audience names (for campaigns).\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "List contacts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ], "query": [ { "key": "tag", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true } ] }, "description": "Your contacts, newest first.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Add or update a contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] }, "body": { "mode": "raw", "raw": "{\n \"phone\": \"+9198250*****\",\n \"name\": \"Riya\",\n \"tags\": [\n \"VIP\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "One contact per number: made the first time, updated after.\n\nPermission: A Full or Send only key." } }, { "name": "Delete a contact", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:phone", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":phone" ], "variable": [ { "key": "phone", "value": "" } ] }, "description": "Deletes a contact.\n\nPermission: A Full or Send only key." } }, { "name": "A contact", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:phone", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":phone" ], "variable": [ { "key": "phone", "value": "" } ] }, "description": "One contact by number.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Edit a contact", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:phone", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":phone" ], "variable": [ { "key": "phone", "value": "" } ] }, "description": "Changes the name or your own fields.\n\nPermission: A Full or Send only key." } }, { "name": "Resume marketing messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:phone/resume-marketing", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":phone", "resume-marketing" ], "variable": [ { "key": "phone", "value": "" } ] }, "description": "Undoes stop-marketing, when the person asked for offers again.\n\nPermission: A Full or Send only key." } }, { "name": "Stop marketing messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:phone/stop-marketing", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":phone", "stop-marketing" ], "variable": [ { "key": "phone", "value": "" } ] }, "description": "Marks that this person does not want marketing messages. Marketing templates and campaigns then leave them out.\n\nPermission: A Full or Send only key." } }, { "name": "Add or remove tags", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/:phone/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", ":phone", "tags" ], "variable": [ { "key": "phone", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"add\": [\n \"VIP\"\n ],\n \"remove\": [\n \"New\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds and removes tags on one contact.\n\nPermission: A Full or Send only key." } }, { "name": "List tags", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tags" ] }, "description": "Your tag names.\n\nPermission: Any key (Full, Send only or Read only)." } } ] }, { "name": "Campaigns", "item": [ { "name": "List campaigns", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true } ] }, "description": "Your campaigns, newest first.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Create a campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Diwali offer\",\n \"template\": {\n \"name\": \"diwali_offer\",\n \"language\": \"en\"\n },\n \"audience\": {\n \"tag\": \"VIP\"\n },\n \"values\": {\n \"body\": [\n {\n \"from\": \"contact.name\",\n \"default\": \"there\"\n },\n \"20%\"\n ],\n \"buttons\": [\n {\n \"type\": \"copy_code\",\n \"value\": \"DIWALI20\"\n }\n ]\n },\n \"header_media\": {\n \"type\": \"image\",\n \"url\": \"https://example.com/offer.jpg\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends one approved template to many people now, or at a time you choose. The people: a list of numbers, a tag, or a saved audience. Every check runs first; a refused campaign makes nothing.\n\nPermission: A Full or Send only key." } }, { "name": "A campaign", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "One campaign with its counts and what it spent.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "A campaign's messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:id/messages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":id", "messages" ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Per person: number, status, why it did not reach them, price.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Pause a campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:id/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":id", "pause" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Pauses a sending campaign.\n\nPermission: A Full or Send only key." } }, { "name": "Resume a campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:id/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":id", "resume" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Resumes a paused campaign.\n\nPermission: A Full or Send only key." } }, { "name": "Stop a campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/campaigns/:id/stop", "host": [ "{{baseUrl}}" ], "path": [ "v1", "campaigns", ":id", "stop" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Stops a campaign for good. Stopping a scheduled one cancels it.\n\nPermission: A Full or Send only key." } } ] }, { "name": "Messages", "item": [ { "name": "A received file", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/media/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "media", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "A file someone sent you: its type and a signed download link that works for 15 minutes.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Download a received file", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/media/:id/file", "host": [ "{{baseUrl}}" ], "path": [ "v1", "media", ":id", "file" ], "query": [ { "key": "exp", "value": "", "disabled": false }, { "key": "sig", "value": "", "disabled": false } ], "variable": [ { "key": "id", "value": "" } ] }, "description": "No key needed. The signed link stops working after a short time." } }, { "name": "A message", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "One message: its status, price, what it was charged, and its timeline.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Send buttons or a list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/messages/interactive", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages", "interactive" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+9198250*****\",\n \"body\": \"Shall we deliver today?\",\n \"buttons\": [\n {\n \"id\": \"yes\",\n \"title\": \"Yes\"\n },\n {\n \"id\": \"later\",\n \"title\": \"Later\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends up to 3 reply buttons, or a list, inside the 24-hour window. When the person taps one, you get message.received with its id.\n\nPermission: A Full or Send only key." } }, { "name": "Send a file", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/messages/media", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages", "media" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+9198250*****\",\n \"type\": \"document\",\n \"url\": \"https://example.com/invoice-4521.pdf\",\n \"filename\": \"invoice-4521.pdf\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends an image, video, audio or document by https link, inside the 24-hour window. Largest files: image 5 MB, video 16 MB, audio 16 MB, document 100 MB. A caption is at most 1024 characters (not for audio).\n\nPermission: A Full or Send only key." } }, { "name": "Send an OTP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/messages/otp", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages", "otp" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+9198250*****\",\n \"code\": \"482913\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends a one-time code with your approved authentication template (at most 15 characters, no spaces). Leave out the template when you have exactly one.\n\nPermission: A Full or Send only key." } }, { "name": "Send a template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/messages/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages", "template" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+9198250*****\",\n \"template\": {\n \"name\": \"order_update\",\n \"language\": \"en\"\n },\n \"body\": [\n \"Riya\",\n \"#4521\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends an approved template to one person: its header (text or a file by link), one value per variable, and the values its buttons need.\n\nPermission: A Full or Send only key." } }, { "name": "Send a text reply", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/messages/text", "host": [ "{{baseUrl}}" ], "path": [ "v1", "messages", "text" ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"+9198250*****\",\n \"text\": \"Your order is on its way.\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends text inside the 24-hour window after the person last wrote to you (at most 4096 characters). Outside it, send a template.\n\nPermission: A Full or Send only key." } } ] }, { "name": "Templates", "item": [ { "name": "List templates", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "templates" ], "query": [ { "key": "status", "value": "", "disabled": true }, { "key": "category", "value": "", "disabled": true }, { "key": "language", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true } ] }, "description": "Your templates, with their status and quality.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Create a template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "templates" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"order_ready\",\n \"language\": \"en\",\n \"category\": \"utility\",\n \"body\": \"Hi {{name}}, your order is ready.\",\n \"examples\": {\n \"body:name\": \"Rohan\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a template and sends it for review — the same rules as in the app. It starts as pending.\n\nPermission: A Full key." } }, { "name": "Delete a template", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/templates/:name", "host": [ "{{baseUrl}}" ], "path": [ "v1", "templates", ":name" ], "query": [ { "key": "language", "value": "", "disabled": true } ], "variable": [ { "key": "name", "value": "" } ] }, "description": "Deletes a template (one language with ?language=, or every language of the name).\n\nPermission: A Full key." } }, { "name": "A template", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/templates/:name", "host": [ "{{baseUrl}}" ], "path": [ "v1", "templates", ":name" ], "query": [ { "key": "language", "value": "", "disabled": true } ], "variable": [ { "key": "name", "value": "" } ] }, "description": "One template by name (add ?language= when it has more than one language).\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Edit a template", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/templates/:name", "host": [ "{{baseUrl}}" ], "path": [ "v1", "templates", ":name" ], "query": [ { "key": "language", "value": "", "disabled": true } ], "variable": [ { "key": "name", "value": "" } ] }, "description": "Edits a template; it goes for review again. The name, language and an approved category stay.\n\nPermission: A Full key." } } ] }, { "name": "Webhooks", "item": [ { "name": "List webhooks", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "description": "Your webhooks. The signing secret is never listed.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "Add a webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/whatsapp-events\",\n \"events\": [\n \"message.delivered\",\n \"message.received\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds an https link we post events to (at most 5). The signing secret is in this answer only.\n\nPermission: A Full key." } }, { "name": "Delete a webhook", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Deletes a webhook. Nothing is sent to it again.\n\nPermission: A Full key." } }, { "name": "A webhook's deliveries", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "deliveries" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Every try of the last 7 days: the event, the status code and how long it took. Never the body.\n\nPermission: Any key (Full, Send only or Read only)." } }, { "name": "New signing secret", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Makes a new secret, shown once. The old one keeps signing for 24 hours, beside the new one.\n\nPermission: A Full key." } }, { "name": "Send a test event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Queues a webhook.test event for this webhook.\n\nPermission: A Full key." } } ] } ] }