MyOperator offers an HTTP-based API that follows REST principles, allowing easy integration with standard HTTP clients like cURL. The API URLs are structured around resources, with requests formatted in form-encoded style and responses delivered in JSON.
\nThe API uses two HTTP methods based on the operation type:
\nThe HTTP method (such as GET or POST) defines the type of operation performed on a resource. For GET requests, query parameters can be used to specify additional options. For POST requests, parameters supply the data needed for write operations, such as creating or updating resources.
\nThe response is in JSON format. Currently, MyOperator does not support any other response format.
\nAs you explore the MyOperator WhatsApp API and its documentation, you'll encounter various concepts, variables, and terms essential to understanding its functionality. Below is a guide to these key concepts and where you can locate them within the MyOperator app.
\nBase URL: The base URL is to access the public APIs. You can use https://publicapi.myoperator.co to access the public APIs
\nApi Key: MyOperator authenticates your API requests using your account's API keys. You can find the keys on Myoperator Panel > Manage > Whatsapp APIs> Whats app API Key
\nCompany id: A unique identifier of company in MyOperator. You can find the company ID on Myoperator Panel > Manage > Whatsapp APIs> company id
\nPhone number id: A unique identifier of Whatsapp phone number in MyOperator. You can find the ID by \"List Phone numbers\" or Go to Myoperator Panel > Manage > WhatsApp >WhatsApp Accounts >Phone number id
\nWaba id: A unique identifier of Whatsapp account. You can find the waba ID on Myoperator Panel > Manage > WhatsApp >Whatsapp Accounts >WABA ID
\nTemplate Variables: Template variables are used to send the template with variable. You can find the template variables in list template API or in Myoperator panel→ Manage→ WhatsApp→ Templates, hover on the variable to see the template variable name.
\nMedia ID: Media ID is used to send the media(image/video/document) template You can use the \"upload media\" API which will return the media ID.
\nStandard HTTP error codes are returned in the case of a failure. 2xx codes indicate a successful message; 4xx codes indicate an error caused by information provided by the client; and 5xx codes indicate an error on MyOperator servers.
\nCreate template API allows you to create a template at Meta.
\nNote: To create a media template use media/upload api to upload a media and get media_id
Fetches details of all templates, including template names, types, and associated variables.
\n","urlObject":{"path":["chat","templates"],"host":["https://publicapi.myoperator.co"],"query":[{"description":{"content":"Waba ID
\n","type":"text/plain"},"key":"waba_id","value":"{{waba_id}}"},{"description":{"content":"Comma separated values are allowed
\n","type":"text/plain"},"key":"waba_template_status","value":"approved"},{"description":{"content":"Comma separated values are allowed
\n","type":"text/plain"},"key":"category","value":"marketing,utility"},{"description":{"content":"No of records per page
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Offset of records
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"184dc2d9-497b-421b-bd45-415e8df2d1c7","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/templates?waba_id={{waba_id}}&waba_template_status=approved&category=marketing&limit=10&offset=0","host":["https://publicapi.myoperator.co"],"path":["chat","templates"],"query":[{"key":"waba_id","value":"{{waba_id}}","description":"Waba ID"},{"key":"waba_template_status","value":"approved","description":"Comma separated values are allowed"},{"key":"category","value":"marketing","description":"Comma separated values are allowed"},{"key":"limit","value":"10","description":"No of records per page"},{"key":"offset","value":"0","description":"Offset of records"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Templates\",\n \"data\": {\n \"count\": 3,\n \"next\": \"https://publicapi.myoperator.co/chat/templates?limit=10&offset=10\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"ed7f9d6d-b461-4a22-9524-bb60ab6ccb19\",\n \"name\": \"bresc\",\n \"waba_template_id\": \"8431010430223812\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"type\": \"template\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"MEDIA\",\n \"media_id\": \"c9103bab-14e5-4ef6-ad4a-3645ce959a4e\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hello{{2}}\\n\\nThis is vector test.\\n\\nTo testes the template creation on responsive. \\n\\nThanks{{3}}\",\n \"example\": {\n \"2\": \"Tedt\",\n \"3\": \"Ted test\"\n }\n }\n ],\n \"quality\": \"unknown\",\n \"status\": \"active\",\n \"waba_template_status\": \"approved\",\n \"failure_reason\": null,\n \"created\": \"2024-09-24T10:31:07.222424Z\",\n \"modified\": \"2024-09-24T10:31:55.252195Z\"\n },\n {\n \"id\": \"625f3aae-2b8f-4b23-8940-c000c48967ff\",\n \"name\": \"summer_sale\",\n \"waba_template_id\": \"3458504164458970\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"type\": \"template\",\n \"components\": [\n {\n \"type\": \"FOOTER\",\n \"text\": \"Thanks you for your co-operation.\"\n },\n {\n \"type\": \"HEADER\",\n \"format\": \"MEDIA\",\n \"media_id\": \"d2b126ad-deeb-4a22-9595-e149f23b13d9\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"format\": \"STATIC\",\n \"index\": 0,\n \"text\": \"Visit Website\",\n \"url\": \"https://myoperator.com/\"\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Greeting !!!\\n\\nThis is a sample message template for checking the WhatsApp messaging feature.\\n\\nThank You!\\nTeam\\n{{name}}\",\n \"example\": {\n \"name\": \"MyOperator\"\n }\n }\n ],\n \"quality\": \"unknown\",\n \"status\": \"active\",\n \"waba_template_status\": \"approved\",\n \"failure_reason\": null,\n \"created\": \"2024-09-20T10:51:08.722918Z\",\n \"modified\": \"2024-09-21T05:39:55.405413Z\"\n },\n {\n \"id\": \"3103fa83-632e-4658-a3ba-2ae42ac0b578\",\n \"name\": \"account_update\",\n \"waba_template_id\": \"8431010430223812\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"type\": \"template\",\n \"components\": [\n {\n \"type\": \"FOOTER\",\n \"text\": \"Reply with 'STOP' to unsubscribe from updates!\"\n },\n {\n \"type\": \"HEADER\",\n \"format\": \"MEDIA\",\n \"media_id\": \"38143e25-a357-4097-a459-cd6c0ff3be8d\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"index\": 0,\n \"text\": \"STOP\"\n }\n ]\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hello {{name}},\\n\\nWe have noticed that you have updated your account!\\n\\nTeam\\nABC Info\",\n \"example\": {\n \"name\": \"Natasha\"\n }\n }\n ],\n \"quality\": \"unknown\",\n \"status\": \"active\",\n \"waba_template_status\": \"approved\",\n \"failure_reason\": null,\n \"created\": \"2024-09-05T08:33:43.197672Z\",\n \"modified\": \"2024-09-21T05:39:55.399715Z\"\n }\n ]\n }\n}"}],"_postman_id":"6c2dbcbf-47f5-4337-95d9-cd4413cb2cc4"},{"name":"Fetch Template By ID","id":"75b6b70c-e97b-44f7-a969-b4349c1becac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/templates/:id","description":"Retrieve the details of a template by ID.
\n","urlObject":{"path":["chat","templates",":id"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[{"id":"f4822fd9-51d3-4422-9d34-7076616cda4a","description":{"content":"Template ID
\n","type":"text/plain"},"type":"any","value":"4c091d8f-07d6-474b-9e64-5d5545c0d4c3","key":"id"}]}},"response":[{"id":"cbfc00ea-1b1b-48bb-ae2a-9153cbcc96a6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/templates/:id","host":["https://publicapi.myoperator.co"],"path":["chat","templates",":id"],"variable":[{"key":"id","value":"4c091d8f-07d6-474b-9e64-5d5545c0d4c3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"739"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f2ae1183-a3d3-4086-94b2-be996af400ae"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"739"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"close"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"2d54867b-f5af-4570-ad00-0eec58d89895"},{"key":"x-amz-apigw-id","value":"ONW1lF50BcwEUGw="},{"key":"x-amzn-Remapped-Server","value":"gunicorn"},{"key":"x-amzn-Remapped-Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"OK\",\n \"data\": {\n \"id\": \"4c091d8f-07d6-474b-9e64-5d5545c0d4c3\",\n \"name\": \"testing_template_36784\",\n \"waba_template_id\": \"2772786999579839\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"type\": \"template\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"Hello, \\n🎉 Enjoy an exclusive 20% discount on your next purchase at ABC Store! \\n🕒 Hurry, the offer is valid until December 31st. \\n💥 Don't miss out - shop now and save big! \\nFor more details, visit: www.abcstore.com\\n\\nBest regards, \\nCba Store Team\",\n \"example\": {}\n }\n ],\n \"quality\": \"unknown\",\n \"status\": \"active\",\n \"waba_template_status\": \"approved\",\n \"failure_reason\": null,\n \"link_tracking\": false,\n \"created\": \"2025-07-18T13:45:25.020325Z\",\n \"modified\": \"2025-07-18T13:45:40.718548Z\"\n }\n}"},{"id":"85729b32-ab65-46b8-a3ae-c547e0b7bb92","name":"Invalid Template ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/templates/:id","host":["https://publicapi.myoperator.co"],"path":["chat","templates",":id"],"variable":[{"key":"id","value":"7a28af72-ef9b-4453-97ab-1e703ba43d08","description":"Template ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"739"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f2ae1183-a3d3-4086-94b2-be996af400ae"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"739"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"close"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"2d54867b-f5af-4570-ad00-0eec58d89895"},{"key":"x-amz-apigw-id","value":"ONW1lF50BcwEUGw="},{"key":"x-amzn-Remapped-Server","value":"gunicorn"},{"key":"x-amzn-Remapped-Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 404,\n \"message\": \"Invalid Template ID\",\n \"errors\": {}\n}"}],"_postman_id":"75b6b70c-e97b-44f7-a969-b4349c1becac"},{"name":"Fetch Template By Name","id":"872fa5ee-80b7-49ef-8797-4ce77176c521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/templates?name=testing_template_36784","description":"Retrieve the details of a template by Name.
\n","urlObject":{"path":["chat","templates"],"host":["https://publicapi.myoperator.co"],"query":[{"description":{"content":"Template Name
\n","type":"text/plain"},"key":"name","value":"testing_template_36784"}],"variable":[]}},"response":[{"id":"84d5a5ee-04b0-4735-9cea-78a943728857","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/templates/:id","host":["https://publicapi.myoperator.co"],"path":["chat","templates",":id"],"variable":[{"key":"id","value":"4c091d8f-07d6-474b-9e64-5d5545c0d4c3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"739"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f2ae1183-a3d3-4086-94b2-be996af400ae"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"739"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"close"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"2d54867b-f5af-4570-ad00-0eec58d89895"},{"key":"x-amz-apigw-id","value":"ONW1lF50BcwEUGw="},{"key":"x-amzn-Remapped-Server","value":"gunicorn"},{"key":"x-amzn-Remapped-Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Templates\",\n \"data\": {\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"4c091d8f-07d6-474b-9e64-5d5545c0d4c3\",\n \"name\": \"testing_template_36784\",\n \"waba_template_id\": \"2772786999579839\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"type\": \"template\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"Hello, \\n🎉 Enjoy an exclusive 20% discount on your next purchase at ABC Store! \\n🕒 Hurry, the offer is valid until December 31st. \\n💥 Don't miss out - shop now and save big! \\nFor more details, visit: www.abcstore.com\\n\\nBest regards, \\nCba Store Team\",\n \"example\": {}\n }\n ],\n \"quality\": \"unknown\",\n \"status\": \"active\",\n \"waba_template_status\": \"approved\",\n \"failure_reason\": null,\n \"link_tracking\": false,\n \"created\": \"2025-07-18T13:45:25.020325Z\",\n \"modified\": \"2025-07-18T13:45:40.718548Z\"\n }\n ]\n }\n}"}],"_postman_id":"872fa5ee-80b7-49ef-8797-4ce77176c521"},{"name":"Delete Template By ID","id":"1a63ed62-8716-4747-aa43-2b2a9caa7649","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/templates/:id","description":"Delete a template by ID
\n","urlObject":{"path":["chat","templates",":id"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[{"id":"f1bddbf3-144c-406b-b3c5-faa948b8a3d4","description":{"content":"Template ID
\n","type":"text/plain"},"type":"any","value":"4c091d8f-07d6-474b-9e64-5d5545c0d4c3","key":"id"}]}},"response":[{"id":"e36f7b2f-b6d5-4057-ac9d-e396bc288ed9","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/templates/:id","host":["https://publicapi.myoperator.co"],"path":["chat","templates",":id"],"variable":[{"key":"id","value":"7a28af72-ef9b-4453-97ab-1e703ba43d07","description":"Template ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"739"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f2ae1183-a3d3-4086-94b2-be996af400ae"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"739"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"close"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"2d54867b-f5af-4570-ad00-0eec58d89895"},{"key":"x-amz-apigw-id","value":"ONW1lF50BcwEUGw="},{"key":"x-amzn-Remapped-Server","value":"gunicorn"},{"key":"x-amzn-Remapped-Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Template Deleted\",\n \"data\": {}\n}"},{"id":"f39d23fb-9c2f-4b94-ac04-f4176543d9cc","name":"Invalid Template ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/templates/:id","host":["https://publicapi.myoperator.co"],"path":["chat","templates",":id"],"variable":[{"key":"id","value":"7a28af72-ef9b-4453-97ab-1e703ba43d08","description":"Template ID"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"739"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f2ae1183-a3d3-4086-94b2-be996af400ae"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"739"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"close"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"2d54867b-f5af-4570-ad00-0eec58d89895"},{"key":"x-amz-apigw-id","value":"ONW1lF50BcwEUGw="},{"key":"x-amzn-Remapped-Server","value":"gunicorn"},{"key":"x-amzn-Remapped-Date","value":"Thu, 24 Jul 2025 10:03:28 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": 404,\n \"message\": \"Invalid Template ID\",\n \"errors\": {}\n}"}],"_postman_id":"1a63ed62-8716-4747-aa43-2b2a9caa7649"}],"id":"8338459a-7a7b-478e-8764-1515fe07d1da","description":"Template APIs
\n","_postman_id":"8338459a-7a7b-478e-8764-1515fe07d1da"},{"name":"Campaigns","item":[{"name":"List Campaign","id":"f5b17f9f-e1e9-455a-b641-c731d8dcd2fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/campaigns?search=june_18&status=completed&ordering=-created&created_at_after=2025-07-10T09:00:00Z&created_at_before=2025-07-10T10:00:00Z&limit=10&offset=0","description":"Fetches details of all campaigns
\n","urlObject":{"path":["chat","campaigns"],"host":["https://publicapi.myoperator.co"],"query":[{"description":{"content":"Search campaign by name (starts with), case insensitive.
\n","type":"text/plain"},"key":"search","value":"june_18"},{"description":{"content":"\"completed\", \"failed\", \"cancelled\", \"running\", \"scheduled\"
\n","type":"text/plain"},"key":"status","value":"completed"},{"description":{"content":"For ordering list of campaigns, default value is \"-created_at\". (possible values are: created_at, schedule_at)
\n","type":"text/plain"},"key":"ordering","value":"-created"},{"description":{"content":"datetime filter on created at (inclusive)
\n","type":"text/plain"},"key":"created_at_after","value":"2025-07-10T09:00:00Z"},{"description":{"content":"Created at (inclusive)
\n","type":"text/plain"},"key":"created_at_before","value":"2025-07-10T10:00:00Z"},{"description":{"content":"No of records per page
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Offset of records
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[{"id":"339b8c80-69f8-4dd6-990f-a725f9ef40b3","name":"List Campaigns","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/campaigns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Jul 2025 10:57:54 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"cd8b6402-7c4c-43fc-b4d9-b7131413f38b"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"108"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"close"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"5d9c8619-a08a-4658-8154-1791b908d830"},{"key":"x-amz-apigw-id","value":"Od9f_GcgBcwEdRA="},{"key":"x-amzn-Remapped-Server","value":"gunicorn"},{"key":"x-amzn-Remapped-Date","value":"Tue, 29 Jul 2025 10:57:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"OK\",\n \"data\": {\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1009,\n \"scheduled_at\": \"2025-07-16T09:48:48.000000Z\",\n \"created_by\": {\n \"uuid\": \"66cd7cc469ca5666\",\n \"name\": \"AdminKuldeep\"\n },\n \"variables_mapping\": [],\n \"template\": {\n \"template_id\": \"0356c107-eb83-49c2-a049-e01856be9669\",\n \"name\": \"document\",\n \"category\": \"marketing\",\n \"template_body\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"MEDIA\",\n \"media_id\": \"751b882e-c714-4038-aef6-8f9f8981868f\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Hello \\n\\nDocument test\",\n \"example\": {}\n }\n ]\n },\n \"audience\": {\n \"file_url\": \"https://myop-chat-stage-campaign.s3.ap-south-1.amazonaws.com/campaign/audience/202507/66c595699b31d875_1752659009.csv\",\n \"file_headers\": [\n \"Name\",\n \"Phone Number\",\n \"Variable1\",\n \"Variable2\",\n \"Country Code\"\n ],\n \"count\": 3,\n \"file_size\": 0,\n \"filename\": \"66c595699b31d875_1752659009.csv\"\n },\n \"status\": \"completed\",\n \"name\": \"new_camp_16jul_002\",\n \"created_at\": \"2025-07-16T09:43:55.840636Z\",\n \"modified_at\": \"2025-07-16T09:49:12.550409Z\",\n \"scheduled_type\": \"scheduled\",\n \"stats\": {\n \"count\": 3,\n \"sent\": 2,\n \"delivered\": 1,\n \"read\": 2,\n \"failed\": 1,\n \"reply\": 1,\n \"started_at\": \"2025-07-16T09:49:02.254197Z\",\n \"finished_at\": null,\n \"billable_count\": 2,\n \"modified_at\": \"2025-07-16T09:50:50.707788Z\"\n }\n }\n ]\n }\n}"}],"_postman_id":"f5b17f9f-e1e9-455a-b641-c731d8dcd2fe"},{"name":"Fetch Campaign By ID","id":"81710b2b-e81f-4fa0-9907-fa1de355be79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/campaign/:id","description":"Retrieve the Campaign Detail by Campaign ID
\n","urlObject":{"path":["chat","campaign",":id"],"host":["https://publicapi.myoperator.co"],"query":[{"disabled":true,"key":"","value":null}],"variable":[{"id":"f98f1328-767d-4787-a60e-d76f57a470b2","description":{"content":"Campaign ID
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2b79fbc5-8e21-40f1-ad43-993f32146d19","name":"Scheduled","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/campaigns/:id","host":["https://publicapi.myoperator.co"],"path":["chat","campaigns",":id"],"variable":[{"key":"id","value":"1009"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"string\",\n \"data\": {\n \"id\": 1,\n \"name\": \"c1\",\n \"created_at\": \"2019-08-24T14:15:22Z\",\n \"modified_at\": \"2024-04-20T10:00:00Z\",\n \"scheduled_at\": \"2019-08-24T14:15:22Z\",\n \"status\": \"scheduled\",\n \"scheduled_type\": \"scheduled\",\n \"created_by\": {\n \"uuid\": \"u1\",\n \"name\": \"A\"\n },\n \"variables_mapping\": [\n {\n \"var_name\": \"name\",\n \"mapping_type\": \"DYNAMIC\",\n \"mapped_value\": \"{{contact_name}}\",\n \"default_value\": \"User\",\n \"scope\": \"body\"\n }\n ],\n \"template\": {\n \"template_id\": \"29db0bad-5da8-4b83-94c9-9362c5947041\",\n \"template_body\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"may end Sale Offers\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"hello {{namew}},\\n\\nWe have the last few days of a big discount on the {{month}} sale., shop and win more discount {{namews}}\"\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Use the buttons below to manage your marketing subscriptions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"index\": 0,\n \"text\": \"Unsubscribe from All\"\n },\n {\n \"type\": \"URL\",\n \"format\": \"STATIC\",\n \"text\": \"Shop Now\",\n \"index\": 2,\n \"url\": \"https://www.myoperator.com/shop/\"\n },\n {\n \"type\": \"URL\",\n \"format\": \"STATIC\",\n \"text\": \"Shop more\",\n \"index\": 3,\n \"url\": \"https://www.myoperator.com/shop2/\"\n },\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call\",\n \"index\": 4,\n \"phone_number\": \"919803374611\"\n }\n ]\n }\n ]\n },\n \"audience\": {\n \"count\": 10,\n \"file_url\": \"url/to/uploaded/audience.csv\",\n \"filename\": \"audience.csv\"\n }\n }\n}"},{"id":"fc5aaa2a-8872-4edc-91db-e4d14971057b","name":"Scheduled (Dynamic URL)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/campaigns/:id","host":["https://publicapi.myoperator.co"],"path":["chat","campaigns",":id"],"variable":[{"key":"id","value":"1009"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"string\",\n \"data\": {\n \"id\": 1,\n \"name\": \"c1\",\n \"created_at\": \"2019-08-24T14:15:22Z\",\n \"modified_at\": \"2024-04-20T10:00:00Z\",\n \"scheduled_at\": \"2019-08-24T14:15:22Z\",\n \"status\": \"scheduled\",\n \"scheduled_type\": \"scheduled\",\n \"created_by\": {\n \"uuid\": \"u1\",\n \"name\": \"A\"\n },\n \"variables_mapping\": [\n {\n \"var_name\": \"name\",\n \"mapping_type\": \"DYNAMIC\",\n \"mapped_value\": \"{{contact_name}}\",\n \"default_value\": \"User\",\n \"scope\": \"body\"\n },\n {\n \"var_name\": \"shop\",\n \"mapping_type\": \"STATIC\",\n \"mapped_value\": \"india-price\",\n \"index\": 1,\n \"scope\": \"button\"\n },\n {\n \"var_name\": \"usa_price\",\n \"mapping_type\": \"DYNAMIC\",\n \"mapped_value\": \"{{ segment }}\",\n \"default_value\": \"usa-price\",\n \"index\": 2,\n \"scope\": \"button\"\n }\n ],\n \"template\": {\n \"template_id\": \"29db0bad-5da8-4b83-94c9-9362c5947041\",\n \"template_body\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"may end Sale Offers\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"hello {{namew}},\\n\\nWe have the last few days of a big discount on the {{month}} sale., shop and win more discount {{namews}}\"\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Use the buttons below to manage your marketing subscriptions\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"index\": 0,\n \"text\": \"Unsubscribe from All\"\n },\n {\n \"type\": \"URL\",\n \"format\": \"DYNAMIC\",\n \"text\": \"Shop Now\",\n \"index\": 1,\n \"url\": \"https://www.myoperator.com/{{shop}}\"\n },\n {\n \"type\": \"URL\",\n \"format\": \"DYNAMIC\",\n \"text\": \"Shop Now More\",\n \"index\": 2,\n \"url\": \"https://www.myoperator.com/{{usa_price}}\"\n },\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Call\",\n \"index\": 4,\n \"phone_number\": \"919803374611\"\n }\n ]\n }\n ]\n },\n \"audience\": {\n \"count\": 10,\n \"file_url\": \"url/to/uploaded/audience.csv\",\n \"filename\": \"audience.csv\"\n }\n }\n}"},{"id":"cffacf18-2e94-4c2f-b5d5-7b68ce2707d9","name":"Completed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/campaigns/:id","host":["https://publicapi.myoperator.co"],"path":["chat","campaigns",":id"],"variable":[{"key":"id","value":"1009"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"string\",\n \"data\": {\n \"id\": 1,\n \"name\": \"c1\",\n \"created_at\": \"2019-08-24T14:15:22Z\",\n \"modified_at\": \"2024-04-20T10:00:00Z\",\n \"scheduled_at\": \"2019-08-24T14:15:22Z\",\n \"status\": \"completed\",\n \"scheduled_type\": \"immediate\",\n \"created_by\": {\n \"uuid\": \"u1\",\n \"name\": \"A\"\n },\n \"variables_mapping\": [\n {\n \"var_name\": \"name\",\n \"mapping_type\": \"DYNAMIC\",\n \"mapped_value\": \"{{contact_name}}\",\n \"default_value\": \"User\",\n \"scope\": \"body\"\n }\n ],\n \"template\": {\n \"template_id\": \"tmp123\"\n },\n \"stats\": {\n \"total\": 10,\n \"sent\": 8,\n \"delivered\": 8,\n \"replied\": 0,\n \"failed\": 2,\n \"read\": 5,\n \"billable\": 6\n },\n \"link_stats\": {\n \"total\": 8,\n \"visited\": 2\n },\n \"audience\": {\n \"count\": 10,\n \"file_url\": \"url/to/uploaded/audience.csv\",\n \"filename\": \"audience.csv\"\n }\n }\n}"},{"id":"5f6f5ae3-e189-4e4e-ba0f-6a272ca4f15b","name":"Completed (Dynamic URL)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/campaigns/:id","host":["https://publicapi.myoperator.co"],"path":["chat","campaigns",":id"],"variable":[{"key":"id","value":"1009"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"string\",\n \"data\": {\n \"id\": 1009,\n \"name\": \"c1\",\n \"created_at\": \"2019-08-24T14:15:22Z\",\n \"modified_at\": \"2024-04-20T10:00:00Z\",\n \"scheduled_at\": \"2019-08-24T14:15:22Z\",\n \"status\": \"completed\",\n \"scheduled_type\": \"immediate\",\n \"created_by\": {\n \"uuid\": \"u1\",\n \"name\": \"A\"\n },\n \"variables_mapping\": [\n {\n \"var_name\": \"name\",\n \"mapping_type\": \"DYNAMIC\",\n \"mapped_value\": \"{{contact_name}}\",\n \"default_value\": \"User\",\n \"scope\": \"body\"\n },\n {\n \"var_name\": \"shop\",\n \"mapping_type\": \"STATIC\",\n \"mapped_value\": \"india-price\",\n \"index\": 1,\n \"scope\": \"button\"\n },\n {\n \"var_name\": \"usa_price\",\n \"mapping_type\": \"DYNAMIC\",\n \"mapped_value\": \"{{ segment }}\",\n \"default_value\": \"usa-price\",\n \"index\": 2,\n \"scope\": \"button\"\n }\n ],\n \"template\": {\n \"template_id\": \"tmp123\"\n },\n \"stats\": {\n \"total\": 10,\n \"sent\": 8,\n \"delivered\": 8,\n \"replied\": 0,\n \"failed\": 2,\n \"read\": 5,\n \"billable\": 6\n },\n \"link_stats\": {\n \"total\": 16,\n \"visited\": 10\n },\n \"audience\": {\n \"count\": 10,\n \"file_url\": \"url/to/uploaded/audience.csv\",\n \"filename\": \"audience.csv\"\n }\n }\n}"},{"id":"47affca1-1bf4-4237-9852-881a8e5088d2","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/campaigns/:id","host":["https://publicapi.myoperator.co"],"path":["chat","campaigns",":id"],"variable":[{"key":"id","value":"1009"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"string\",\n \"data\": {\n \"id\": 1,\n \"name\": \"camp 1\",\n \"created_at\": \"2019-08-24T14:15:22Z\",\n \"modified_at\": \"2024-04-20T10:00:00Z\",\n \"scheduled_type\": \"immediate\",\n \"scheduled_at\": \"2019-08-24T14:15:22Z\",\n \"status\": \"failed\",\n \"failure_reason\": \"daily_limit_reached\",\n \"created_by\": {\n \"uuid\": \"u1\",\n \"name\": \"usr 1\"\n },\n \"stats\": {\n \"total\": 0,\n \"sent\": 0,\n \"delivered\": 0,\n \"replied\": 0,\n \"failed\": 0,\n \"read\": 0,\n \"billable\": 0\n },\n \"variables_mapping\": [\n {\n \"var_name\": \"discount\",\n \"mapping_type\": \"STATIC\",\n \"mapped_value\": \"20\",\n \"scope\": \"body\"\n }\n ],\n \"template\": {},\n \"audience\": {\n \"count\": 10,\n \"file_url\": \"url/to/uploaded/audience.csv\",\n \"filename\": \"audience.csv\"\n }\n }\n}"},{"id":"299371bf-04db-4f19-b00b-0f96c3121096","name":"Invalid Campaign ID","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"X-WABA-PHONENUMBER-ID","value":"{{phone_number_id}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/campaigns/:id","host":["https://publicapi.myoperator.co"],"path":["chat","campaigns",":id"],"variable":[{"key":"id","value":"9359"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"not_found\",\n \"message\": \"Not found.\",\n \"errors\": {\n \"campaign_id\": \"Campaign 9359 does not exist!\"\n }\n}"}],"_postman_id":"81710b2b-e81f-4fa0-9907-fa1de355be79"}],"id":"04dde848-e10d-446f-acee-cd2d9fdc06bb","description":"Campaign APIs
\n","_postman_id":"04dde848-e10d-446f-acee-cd2d9fdc06bb"},{"name":"List Phone Numbers","id":"df5134d7-e0a1-420a-9bc1-422fd14d17dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":"https://publicapi.myoperator.co/chat/phonenumbers?limit=10&offset=0&expand=settings,profile,waba_account&waba_id={{waba_id}}","description":"Retrieves a list of active WhatsApp phone numbers associated with your account.
\n","urlObject":{"path":["chat","phonenumbers"],"host":["https://publicapi.myoperator.co"],"query":[{"description":{"content":"No of records per page
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Offset of records
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"This is a optional Field to get additional information of settings,profile,waba_account
\n","type":"text/plain"},"key":"expand","value":"settings,profile,waba_account"},{"key":"waba_id","value":"{{waba_id}}"}],"variable":[]}},"response":[{"id":"a2ca7899-7502-422c-bf5e-8c211cb5f8de","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/chat/phonenumbers?limit=10&offset=0&waba_id=string","host":["https://publicapi.myoperator.co"],"path":["chat","phonenumbers"],"query":[{"key":"limit","value":"10","description":"No of records per page"},{"key":"offset","value":"0","description":"Offset of records"},{"key":"waba_id","value":"string","description":"Waba ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Sends messages or templates (image, video, or document types) to customers.
\n \"data\": {\n \"type\": \"image\",\n \"context\": {\n \"link\": \"https://example.com/file.jpg\",\n \"filename\": \"FileName.jpg\",\n \"caption\": \"here is the image, that you asked\",\n \"mime_type\": \"image/jpeg\"\n }\n }\n\n \"data\": {\n \"type\": \"audio\",\n \"context\": {\n \"link\": \"https://example.com/file.mp3\",\n \"filename\": \"FileName.mp3\",\n \"caption\": \"here is the audio, that you asked\",\n \"mime_type\": \"audio/mpeg\"\n }\n }\n\n \"data\": {\n \"type\": \"video\",\n \"context\": {\n \"link\": \"https://example.com/file.mp4\",\n \"filename\": \"FileName.mp4\",\n \"caption\": \"here is the video, that you asked\",\n \"mime_type\": \"video/mp4\"\n }\n }\n\n \"data\": {\n \"type\": \"document\",\n \"context\": {\n \"link\": \"https://example.com/file.pdf\",\n \"filename\": \"FileName.pdf\",\n \"caption\": \"here is the document, that you asked\",\n \"mime_type\": \"application/pdf\"\n }\n }\n\nImages must be 8-bit, RGB or RGBA.
\nOnly H.264 video codec and AAC audio codec supported. Single audio stream or no audio stream only.
\n","urlObject":{"path":["chat","messages"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[]}},"response":[{"id":"7092bea0-5391-4910-8772-8d992e354f19","name":"Send Text Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543XXX\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, How are you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"e6f43210-4128-4b6d-a623-9ce1c9c37f93","name":"Send Media Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543XXX\",\n \"data\": {\n \"type\": \"image\",\n \"context\": {\n \"link\": \"https://example.com/file.jpg\",\n \"filename\": \"FileName.jpg\",\n \"caption\": \"here is the image, that you asked\",\n \"mime_type\": \"image/jpeg\"\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"fadde1f2-5e0d-403e-aecd-fd0e6eb74109","name":"Send Template Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543XXX\",\n \"data\": {\n \"type\": \"template\",\n \"language\": \"en\",\n \"context\": {\n \"template_name\": \"start_chat\",\n \"language\": \"en\"\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"100107dc-ea95-44e6-a58b-07c6e52e9f56","name":"Send Carousel Template Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"889618377570081\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"8979783****\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"crousel_template_1\",\n \"body\": {}\n }\n },\n \"myop_ref_id\": null,\n \"reply_to\": null,\n \"trail\": {\n \"name\": null\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"5d9a9f89-1de5-4565-9ac7-733d85c58008","name":"Send Template Message with Static Buttons","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543XXX\",\n \"data\": {\n \"type\": \"template\",\n \"language\": \"en\",\n \"context\": {\n \"template_name\": \"start_chat\",\n \"language\": \"en\"\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"2bdb617c-9284-4a39-a2ca-d120cfd2137c","name":"Send Template Message With Body Param","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"start_chat\",\n \"language\": \"en\",\n \"body\": {\n \"customer_name\": \"John Doe\"\n }\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"ca56efae-e8b6-43df-92f1-754728ec8b60","name":"Send Template Message Header Media ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"start_chat\",\n \"language\": \"en\",\n \"header\": {\n \"media_id\": \"3584c407-0f36-44b4-8eea-5b19da63eb31\"\n },\n \"body\": {\n \"customer_name\": \"John Doe\"\n }\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"1a586f27-f679-47ce-ad8e-15d504f7e898","name":"Send Template Message Header Media URL","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"start_chat\",\n \"language\": \"en\",\n \"header\": {\n \"media_url\": \"https://example.com/file.jpg\"\n },\n \"body\": {\n \"customer_name\": \"John Doe\"\n }\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"cb13936d-e44d-4e2d-ab09-fbf1e1698b2e","name":"Send Template Message Header Param","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"start_chat\",\n \"language\": \"en\",\n \"header\": {\n \"sale_month\": \"June\"\n },\n \"body\": {\n \"customer_name\": \"John Doe\"\n }\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null}\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"998a7ce0-65ac-47b2-83c9-f374151d8f92","name":"Send Template Message Dynamic URL","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"5fdaa860-b2b7-441b-a715-50f8f2f5f4cb\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"reply_to\": \"\",\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null},\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"dynamic_url_template\",\n \"language\": \"en\",\n \"body\": {\n \"var_1\": \"June\",\n \"var_2\": \"Vipan\"\n },\n \"buttons\": [\n {\n \"var1\": \"usa-price\",\n \"index\": 0\n },\n {\n \"var1\": \"india-price\",\n \"index\": 1\n }\n ]\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"639c9995-75f7-495f-996a-fd3546c5e806","name":"Send Template Message Authentication","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"5fdaa860-b2b7-441b-a715-50f8f2f5f4cb\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"reply_to\": null,\n \"myop_ref_id\": null,\n \"trail\": {\"name\": null},\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_name\": \"auth_temp\",\n \"body\": {\n \"otp\": \"123456\"\n },\n \"buttons\": [\n {\n \"otp\": \"123456\",\n \"index\": 0\n }\n ]\n}\n\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"310d3709-53fa-4b4f-9831-d62b1db1efbf","name":"Reply to Message","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": \"d0f4b85e-45a9-4e13-9d9a-6273b8c113bf\",\n \"myop_ref_id\": null\n} ","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Message Sent\",\n \"data\": {\n \"message_id\": \"d7d9d9fd-478f-40e6-b651-49b7f19878a2\",\n \"conversaton_id\": \"dc595fd8-aaf3-4b97-97c1-311ba07d3e2e\"\n }\n}"},{"id":"7dd056b6-e9f8-43e0-895d-23b38aa7bd5c","name":"Validation Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": \"d0f4b85e-45a9-4e13-9d9a-6273b8c113bf\",\n \"myop_ref_id\": \"5dc5120f-b725-44ed-b068-a634321c7da4\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"400\",\n \"message\": \"Missing required fields or Invalid Input\",\n \"error\": {\n \"phone_number_id\": [\n \"phone_number_id is required\"\n ]\n }\n}"},{"id":"7527b6d9-9b5b-4cf9-a8ae-ae217942b150","name":"Template Not associated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"400\",\n \"message\": \"Template not associated with this company\",\n \"errors\": {}\n}"},{"id":"514a3ea1-a011-4ebf-b9ab-ee3022fbe1bb","name":"Insufficient Balance","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"CHAT_4001\",\n \"message\": \"Insufficient Balance\",\n \"error\": {}\n}"},{"id":"ebf2aa84-46a2-44f2-963a-561358016e7c","name":"Message Sending Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"CHAT_3001\",\n \"message\": \"Message Sending Failed\",\n \"error\": {}\n}"},{"id":"cab8a03d-6957-40a7-b380-c36068902ea6","name":"Waba disabled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"CHAT_0302\",\n \"message\": \"Waba is Disabled\",\n \"error\": {}\n}"},{"id":"decf8549-8762-42c4-9e50-d4d1403d5901","name":"Phone Number is Disabled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"CHAT_0303\",\n \"message\": \"Phone Number is Disabled\",\n \"error\": {}\n}"},{"id":"af5543ed-5e6d-499d-a2bb-0cb61800d2ce","name":"Phone Number is not connected","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"CHAT_0304\",\n \"message\": \"Phone Number is not connected\",\n \"error\": {}\n}"},{"id":"1e566298-0352-46c2-835b-22d14581f138","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi John!, Thanks for reaching us, How can i help you?\",\n \"preview_url\": false\n }\n },\n \"reply_to\": null,\n \"myop_ref_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://publicapi.myoperator.co/chat/messages"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"Internal Server Error"},{"id":"b43d199c-f185-4ee3-9c3e-5d39766463d5","name":"Interactive button type with Text Header","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","description":"Added as a part of security scheme: apikey"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone_number_id\": \"87673432323365\",\n \"customer_country_code\": \"91\",\n \"customer_number\": \"9876543210\",\n \"data\": {\n \"type\": \"interactive\",\n \"context\": {\n \"interactive_type\": \"button\",\n \"header\": {\n \"type\": \"document | video | image\",\n \"media_id\": \"(Required)
\n","key":"file","type":"file","value":null},{"description":"(Required) (This can only be one of messaging,template)
\n","key":"application","value":"template","type":"text"}]},"url":"https://publicapi.myoperator.co/chat/media/upload","description":"Uploads media files (image, video, or document) for use in template messages. This API returns a Media ID for each uploaded file.
\nMax Upload Limit is set to 10MB
\n","urlObject":{"path":["chat","media","upload"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[]}},"response":[{"id":"a7f0df2b-ba3f-4e8d-8b1a-4e71f741e36c","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Bearer {{apikey}}"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"file","type":"file","value":null},{"description":"(Required) (This can only be one of messaging,template)","key":"application","value":"template","type":"text"}]},"url":"https://publicapi.myoperator.co/chat/media/upload"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\"status\": \"success\",\n\"code\": \"201\",\n\"message\": \"Media uploaded successfully\",\n\"data\": {\n\"media_id\": \"c3941c26-6c76-4e7b-a711-852f901401a6\"\n}\n}"},{"id":"e31f8860-5545-46ed-bb51-2ad546b18dba","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":"Bearer {{apikey}}"},{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) ","key":"file","type":"file","value":null},{"description":"(Required) (This can only be one of messaging,template)","key":"application","value":"template","type":"text"}]},"url":"https://publicapi.myoperator.co/chat/media/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"invalid\",\n \"message\": \"Invalid input.\",\n \"errors\": {\n \"file\": [\n \"file_size 44509 KB not allowed for file_type video/mp4!\"\n ]\n }\n}"}],"_postman_id":"aa385399-b7d3-4a2a-833b-8d1a8f7aca71"}],"id":"ac822cd8-454d-42bb-baaf-ad6b5dcc7e03","_postman_id":"ac822cd8-454d-42bb-baaf-ad6b5dcc7e03","description":""},{"name":"Whatsapp Webhook Responses","item":[{"name":"Send text message - Sent","id":"9623b345-8796-4b57-8cf3-f78766c59251","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"{\n \"type\": \"message\",\n \"source\": \"lc\",\n \"mode\": \"lc\",\n \"event\": \"sent\",\n \"timestamp\": \"2024-11-04T04:27:28.857052Z\",\n \"data\": {\n \"id\": \"774b7514-a3c8-4828-9e74-38fed3d632dd\",\n \"message_by\": \"66c595699c864114\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": true,\n \"reply_to\": \"8ba75519-174a-497d-a3a8-5b3d1d3b90e6\",\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Sed sapiente quia voluptas dolores atque tenetur in. Qui quod id omnis debitis ut. Est voluptas totam rem. http://phoebe.biz\",\n \"preview_url\": true\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3OTAwNzY2MDcwFQIAERgSMjZBMzEwRkJEQzhGNUM4QTNDAA==\",\n \"myop_ref_id\": \"test123\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2024-11-04T04:27:20.737046Z\",\n \"modified\": \"2024-11-04T04:27:28.468501Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2024-11-04T04:27:25.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"8c661491-ae41-492b-bae9-fcbd4246bb7d\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7900766070\",\n \"customer_name\": \"Kuldeep Malhotra\",\n \"assigned_to\": \"66c595699c864114\",\n \"status\": \"assigned\",\n \"expire_at\": \"2024-11-05T04:19:26.828750Z\",\n \"last_message_at\": \"2024-11-04T04:27:20.737046Z\",\n \"created\": \"2024-11-04T04:17:58.970663Z\",\n \"modified\": \"2024-11-04T04:19:26.831916Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"411835805357155\"\n }\n}\n\n{\n \"type\": \"message\",\n \"source\": \"lc\",\n \"mode\": \"lc\",\n \"event\": \"delivered\",\n \"timestamp\": \"2024-11-04T04:27:28.957976Z\",\n \"data\": {\n \"id\": \"774b7514-a3c8-4828-9e74-38fed3d632dd\",\n \"message_by\": \"66c595699c864114\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": true,\n \"reply_to\": \"8ba75519-174a-497d-a3a8-5b3d1d3b90e6\",\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Sed sapiente quia voluptas dolores atque tenetur in. Qui quod id omnis debitis ut. Est voluptas totam rem. http://phoebe.biz\",\n \"preview_url\": true\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3OTAwNzY2MDcwFQIAERgSMjZBMzEwRkJEQzhGNUM4QTNDAA==\",\n \"myop_ref_id\": \"test123\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2024-11-04T04:27:20.737046Z\",\n \"modified\": \"2024-11-04T04:27:28.468501Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2024-11-04T04:27:25.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"8c661491-ae41-492b-bae9-fcbd4246bb7d\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7900766070\",\n \"customer_name\": \"Kuldeep Malhotra\",\n \"assigned_to\": \"66c595699c864114\",\n \"status\": \"assigned\",\n \"expire_at\": \"2024-11-05T04:19:26.828750Z\",\n \"last_message_at\": \"2024-11-04T04:27:20.737046Z\",\n \"created\": \"2024-11-04T04:17:58.970663Z\",\n \"modified\": \"2024-11-04T04:19:26.831916Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"411835805357155\"\n }\n}\n\n{\n \"type\": \"message\",\n \"source\": \"lc\",\n \"mode\": \"lc\",\n \"event\": \"read\",\n \"timestamp\": \"2024-11-04T04:29:18.937643Z\",\n \"data\": {\n \"id\": \"774b7514-a3c8-4828-9e74-38fed3d632dd\",\n \"message_by\": \"66c595699c864114\",\n \"action\": \"outgoing\",\n \"status\": \"read\",\n \"is_reply\": true,\n \"reply_to\": \"8ba75519-174a-497d-a3a8-5b3d1d3b90e6\",\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Sed sapiente quia voluptas dolores atque tenetur in. Qui quod id omnis debitis ut. Est voluptas totam rem. http://phoebe.biz\",\n \"preview_url\": true\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3OTAwNzY2MDcwFQIAERgSMjZBMzEwRkJEQzhGNUM4QTNDAA==\",\n \"myop_ref_id\": \"test123\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2024-11-04T04:27:20.737046Z\",\n \"modified\": \"2024-11-04T04:29:18.618304Z\",\n \"is_read\": true,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2024-11-04T04:27:25.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2024-11-04T04:27:26.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": \"2024-11-04T04:29:16.000000Z\"\n }\n ],\n \"conversation\": {\n \"id\": \"8c661491-ae41-492b-bae9-fcbd4246bb7d\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7900766070\",\n \"customer_name\": \"Kuldeep Malhotra\",\n \"assigned_to\": \"66c595699c864114\",\n \"status\": \"assigned\",\n \"expire_at\": \"2024-11-05T04:19:26.828750Z\",\n \"last_message_at\": \"2024-11-04T04:27:20.737046Z\",\n \"created\": \"2024-11-04T04:17:58.970663Z\",\n \"modified\": \"2024-11-04T04:19:26.831916Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"411835805357155\"\n }\n}\n\n{\n \"type\": \"message\",\n \"source\": \"lc\",\n \"mode\": \"lc\",\n \"event\": \"sent\",\n \"timestamp\": \"2024-11-04T05:31:01.522300Z\",\n \"data\": {\n \"id\": \"baf5713b-cee8-482d-a963-ede0d1aafded\",\n \"message_by\": \"66c595699c864114\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"id\": \"c8a1cb0c-0df7-474c-be0d-20fa84a40f59\",\n \"name\": \"thanks_template\",\n \"language\": \"en\",\n \"category\": \"utility\",\n \"header\": {\n \"format\": \"text\",\n \"text\": \"Thanks\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hello,\\n\\nThanks for choosing us.\\n\\nTeam\\nMOlien\"\n }\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3NzM3MjM3NDM3FQIAERgSNEJCODA4QzUzM0I0MEJFRTE0AA==\",\n \"myop_ref_id\": \"\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2024-11-04T05:30:55.721410Z\",\n \"modified\": \"2024-11-04T05:31:01.102543Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2024-11-04T05:30:57.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"70fe53f2-778b-4c53-b0ab-d49d796f487c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7737237437\",\n \"customer_name\": \"Kuldeep Malhotra 👨🏻🦰\",\n \"assigned_to\": \"66c595699c864114\",\n \"status\": \"assigned\",\n \"expire_at\": \"2024-10-30T12:13:14.256691Z\",\n \"last_message_at\": \"2024-11-04T05:30:55.721410Z\",\n \"created\": \"2024-10-15T12:13:34.915068Z\",\n \"modified\": \"2024-10-30T08:40:00.133390Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"411835805357155\"\n }\n}\n\n{\n \"type\": \"message\",\n \"source\": \"cmp\",\n \"mode\": \"lc\",\n \"event\": \"message.link_tracking\",\n \"timestamp\": \"2025-03-25T12:46:48.390467Z\",\n \"data\": {\n \"conversation\": {\n \"id\": \"429257a8-13e6-4edf-87a5-e57c931a823f\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"8979783746\",\n \"customer_name\": \"918979783746\",\n \"assigned_to\": \"67c7fa3f6b227448\",\n \"status\": \"assigned\",\n \"expire_at\": null,\n \"last_message_at\": \"2025-03-25T12:44:03.818808Z\",\n \"created\": \"2025-03-08T16:09:18.272520Z\",\n \"modified\": \"2025-03-08T16:09:18.272540Z\",\n \"unread_count\": 0\n },\n \"link_tracking\": {\n \"template_id\": \"0e3e9473-b309-4f9f-8330-f573410f797f\",\n \"template_name\": \"link_tracking_both\",\n \"button_info\": \"btn-1\",\n \"clicked_at\": \"2025-03-25T12:46:48.390467Z\"\n },\n \"activity\": null,\n \"id\": \"316a9a44-92aa-47ef-ba7f-b43976c1d7fd\",\n \"source\": \"cmp\",\n \"action\": \"outgoing\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"0e3e9473-b309-4f9f-8330-f573410f797f\",\n \"name\": \"link_tracking_both\",\n \"language\": \"en\",\n \"category\": 1,\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"format\": \"STATIC\",\n \"index\": 0,\n \"text\": \"1\",\n \"url\": \"https://www.google.com\"\n },\n {\n \"type\": \"URL\",\n \"format\": \"DYNAMIC\",\n \"index\": 1,\n \"text\": \"2\",\n \"url\": \"https://myoperator.com/Nikita\"\n }\n ],\n \"body\": {\n \"type\": \"text\",\n \"context\": \"This is for link traking both on\"\n },\n \"template_payload\": {\n \"buttons\": [\n {\n \"index\": 1,\n \"1\": \"Nikita\"\n }\n ]\n }\n }\n },\n \"status\": \"read\",\n \"is_read\": true,\n \"message_by\": \"67c7fa3f6b227448\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE4OTc5NzgzNzQ2FQIAERgSNzM2NzI2Q0FFQkMwRDIyQzgwAA==\",\n \"myop_ref_id\": \"\"\n },\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2025-03-25T12:44:13.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2025-03-25T12:44:16.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": \"2025-03-25T12:45:58.000000Z\"\n }\n ],\n \"created\": \"2025-03-25T12:44:03.818808Z\",\n \"modified\": \"2025-03-25T12:46:16.841336Z\",\n \"errors\": null,\n \"conversation_id\": \"429257a8-13e6-4edf-87a5-e57c931a823f\",\n \"phone_number_id\": \"512928915247810\"\n }\n}\n\n{\n \"type\": \"message\",\n \"source\": \"lc\",\n \"mode\": \"lc\",\n \"event\": \"delivered\",\n \"timestamp\": \"2024-11-04T05:31:01.729972Z\",\n \"data\": {\n \"id\": \"baf5713b-cee8-482d-a963-ede0d1aafded\",\n \"message_by\": \"66c595699c864114\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"id\": \"c8a1cb0c-0df7-474c-be0d-20fa84a40f59\",\n \"name\": \"thanks_template\",\n \"language\": \"en\",\n \"category\": \"utility\",\n \"header\": {\n \"format\": \"text\",\n \"text\": \"Thanks\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hello,\\n\\nThanks for choosing us.\\n\\nTeam\\nMOlien\"\n }\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3NzM3MjM3NDM3FQIAERgSNEJCODA4QzUzM0I0MEJFRTE0AA==\",\n \"myop_ref_id\": \"\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2024-11-04T05:30:55.721410Z\",\n \"modified\": \"2024-11-04T05:31:01.102543Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2024-11-04T05:30:57.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"70fe53f2-778b-4c53-b0ab-d49d796f487c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7737237437\",\n \"customer_name\": \"Kuldeep Malhotra 👨🏻🦰\",\n \"assigned_to\": \"66c595699c864114\",\n \"status\": \"assigned\",\n \"expire_at\": \"2024-10-30T12:13:14.256691Z\",\n \"last_message_at\": \"2024-11-04T05:30:55.721410Z\",\n \"created\": \"2024-10-15T12:13:34.915068Z\",\n \"modified\": \"2024-10-30T08:40:00.133390Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"411835805357155\"\n }\n}\n\n{\n \"type\": \"message\",\n \"source\": \"lc\",\n \"mode\": \"lc\",\n \"event\": \"failed\",\n \"timestamp\": \"2024-11-04T04:43:31.469990Z\",\n \"data\": {\n \"id\": \"06e13889-1eb0-4e2c-b22c-885aa6a46583\",\n \"message_by\": \"66c595699c864114\",\n \"action\": \"outgoing\",\n \"status\": \"failed\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"image\",\n \"context\": {\n \"link\": \"https://file-examples.com/wp-content/storage/2017/10/file_example_JPG_2500kB.jpg\",\n \"filename\": \"JPEG_example_flower.jpg\",\n \"caption\": \"टेक्स्ट और टेम्प्लेट के साथ संदेश भेजें\",\n \"mime_type\": \"image/jpeg\"\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3OTAwNzY2MDcwFQIAERgSRjUwNzM3NTU1OEUyQTE4RjM4AA==\",\n \"myop_ref_id\": \"\",\n \"errors\": {\n \"WABA_131053\": \"Media upload error\"\n }\n },\n \"star_mark\": false,\n \"created\": \"2024-11-04T04:43:25.610825Z\",\n \"modified\": \"2024-11-04T04:43:31.186478Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": null\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"8c661491-ae41-492b-bae9-fcbd4246bb7d\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7900766070\",\n \"customer_name\": \"Kuldeep Malhotra\",\n \"assigned_to\": \"66c595699c864114\",\n \"status\": \"assigned\",\n \"expire_at\": \"2024-11-05T04:19:26.828750Z\",\n \"last_message_at\": \"2024-11-04T04:43:25.610825Z\",\n \"created\": \"2024-11-04T04:17:58.970663Z\",\n \"modified\": \"2024-11-04T04:19:26.831916Z\",\n \"unread_count\": 0\n },\n \"activity\": null\n }\n}\n\nWebhooks are server callbacks from MyOperator's server to your own, triggered by specific events related to messages. These event-based notifications allow you to stay updated on message statuses.
\nTo configure a webhook, go to MyOperator > Manage > API Integration > WhatsApp Webhook and set it up.
\nMyOperator sends the following payloads for message events:
Message Sent: Triggered when any message or template is sent via Live Chat, Campaign, or API.
Message Delivered: Triggered when a message or template is delivered to the customer.
Message Read: Triggered when a message or template is read by the customer.
Message Failed: Triggered when a message or template fails to send.
Create contact Required Fields:
\nname
\ncountry_code
\nphone_number
\nCreate contact Required Fields:
\nname
\ncountry_code
\nphone_number
\nThis API allows you to filter contacts dynamically using a flexible JSON-based query structure. You can apply filters on both standard fields and custom fields using supported operations.
\nAll filters must follow this structure:
\n{\n \"and\": {\n \"<field_name>__<operation>\": <value>\n }\n}\n\nand: Combines multiple conditions (logical AND)
: The field you want to filter on
\n: The operation to apply
\n: The value to compare against
\nname
country_code
phone_number_with_cc
email_id
marketing_opt_in
status
source
created
modified
Custom fields must be referenced using the following format:
\ncustom_fields.<field_id>\n\n📌 Example:
\ncustom_fields.my_custom_field_id_1\n\n📎 To get your field_id, refer to:
👉 https://in.app.myoperator.com/contacts/custom-fields
{\n \"and\":{\n \"name__is\": \"John\",\n \"country_code__is\": \"91\",\n \"phone_number__is\": \"9876543210\",\n \"phone_number_with_cc__is\": \"919876543210\",\n \"email_id__contains\": \"john\",\n \"email_id__not_contains\": \"doe\",\n \"marketing_opt_in__is\": true,\n \"status__is_not\": 0,\n \"source__is\": \"manual_entry\",\n \"created__gt\": \"2025-01-01\",\n \"modified__lte\": \"2025-01-01\",\n \"custom_fields.my_custom_field_id_1__is\": \"prime\", // customer_type (single_select type custom field with possible values: prime, regular)\n \"custom_fields.my_custom_field_id_2__gte\": 18, // age (number type custom field)\n \"custom_fields.my_custom_field_id_3__range\": {\n \"gte\": \"1990-01-01\",\n \"lte\": \"1995-12-31\",\n }, // dob (date type custom field)\n \"custom_fields.my_custom_field_id_4__is\": [\"python\", \"php\"], // skills (multi_select type custom field with possible values: python, php, mysql)\n }\n}\n\nMultiple filters inside \"and\" are combined using logical AND
Use correct data types for each operation (e.g., dates in YYYY-MM-DD)
multi_select fields accept arrays (e.g., [\"python\", \"golang\"])
range and not_range require both gte and lte
Always verify custom field IDs before use
\nSearch token for backward pagination
\n","type":"text/plain"},"key":"before","value":""},{"description":{"content":"Search token for forward pagination
\n","type":"text/plain"},"key":"after","value":null}],"variable":[]}},"response":[{"id":"fe425ad8-a070-4bf2-b682-d5bda8c07bb3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"and\": {\n \"source__is\": [\"manual_entry\", \"waba_campaigns\", \"waba_message\", \"imported\", \"public_api\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://publicapi.myoperator.co/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"message\": \"Contacts Searched\",\n \"data\": {\n \"total\": 2,\n \"filter_total\": 1406,\n \"results\": [\n {\n \"id\": \"67c839bc3c8428fefec921ba\",\n \"email_id\": null,\n \"marketing_opt_in\": false,\n \"name\": \"Sumit 12\",\n \"phone_number\": \"98921XXXXX\",\n \"country_code\": \"91\",\n \"source\": \"imported\",\n \"created\": \"2025-03-05T11:47:08.574000Z\",\n \"modified\": \"2026-02-05T08:07:51.149000Z\",\n \"status\": \"active\",\n \"pagination_token\": \"WyI2N2M4MzliYzNjODQyOGZlZmVjOTIxYmEiLDE3NDExNzUyMjg1NzRd\"\n },\n {\n \"id\": \"67c839bc3c8428fefec921bb\",\n \"email_id\": null,\n \"marketing_opt_in\": false,\n \"name\": \"Shruti\",\n \"phone_number\": \"98334XXXXX\",\n \"country_code\": \"91\",\n \"source\": \"imported\",\n \"created\": \"2025-03-05T11:47:08.575000Z\",\n \"modified\": \"2026-02-04T15:23:55.967000Z\",\n \"status\": \"active\",\n \"pagination_token\": \"WyI2N2M4MzliYzNjODQyOGZlZmVjOTIxYmIiLDE3NDExNzUyMjg1NzVd\"\n }\n ]\n }\n}"}],"_postman_id":"f8fdfc25-48fe-40ca-bd83-06fbae0c15e2"},{"name":"Fetch Contacts","id":"5c6a73aa-94a2-47e2-9222-9c71c4e78b6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://publicapi.myoperator.co/contacts?limit=5","description":"max Limit which can be set is 100, default is 10
\n","urlObject":{"path":["contacts"],"host":["https://publicapi.myoperator.co"],"query":[{"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"e84b5159-2c2f-4fbf-afb2-d22954856090","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/contacts?limit=5","host":["https://publicapi.myoperator.co"],"path":["contacts"],"query":[{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:45:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1559"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"303f3bba-b6bc-4149-bb25-3294f0d65070"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"1559"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"d6e7dc09-9d56-47b4-97d3-75bd13049ce7"},{"key":"x-amz-apigw-id","value":"FjmocGkLhcwEQlg="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:45:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Data\",\n \"data\": {\n \"count\": 10,\n \"next\": \"https://publicapi.myoperator.co/contacts?limit=5&offset=5\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"67a1f59b1e0abbf2e03aa40b\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"Kuldeep Malhotra\",\n \"country_code\": \"91\",\n \"phone_number\": \"7737******\",\n \"email_id\": null,\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"created\": \"2025-02-04T11:10:19.390000Z\",\n \"modified\": \"2025-02-04T11:10:19.390000Z\"\n },\n {\n \"id\": \"67a1f4e962a74787ffea12fb\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"own number\",\n \"country_code\": \"91\",\n \"phone_number\": \"7900******\",\n \"email_id\": null,\n \"marketing_opt_in\": false,\n \"status\": \"active\",\n \"created\": \"2025-02-04T11:07:21.766000Z\",\n \"modified\": \"2025-02-04T11:07:21.766000Z\"\n },\n {\n \"id\": \"67a1f21362a74787ffea12fa\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"sdvsdv\",\n \"country_code\": \"91\",\n \"phone_number\": \"2269******\",\n \"email_id\": null,\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"created\": \"2025-02-04T10:55:15.501000Z\",\n \"modified\": \"2025-02-04T10:55:15.501000Z\"\n },\n {\n \"id\": \"67a19a9ee86d84da4ad01c80\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"Sumanta Bhui\",\n \"country_code\": \"91\",\n \"phone_number\": \"7501******\",\n \"email_id\": null,\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"created\": \"2025-02-04T04:42:06.677000Z\",\n \"modified\": \"2025-02-04T04:42:06.678000Z\"\n },\n {\n \"id\": \"67a10be487c2e8932409549c\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"Shubham 10\",\n \"country_code\": \"91\",\n \"phone_number\": \"2342******\",\n \"email_id\": \"Shubham8@yopmail.com\",\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"created\": \"2025-02-03T18:33:08.467000Z\",\n \"modified\": \"2025-02-03T18:33:08.467000Z\"\n }\n ]\n }\n}"}],"_postman_id":"5c6a73aa-94a2-47e2-9222-9c71c4e78b6b"},{"name":"Fetch Contacts with custom fields","id":"6371d484-66e2-4e5b-9011-ec4e1ff341b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://publicapi.myoperator.co/contacts?include=custom_fields&limit=5","description":"max Limit which can be set is 100, default is 10
\n","urlObject":{"path":["contacts"],"host":["https://publicapi.myoperator.co"],"query":[{"key":"include","value":"custom_fields"},{"key":"limit","value":"5"}],"variable":[]}},"response":[{"id":"70481420-3122-421d-b321-b928a42d4784","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/contacts?include=custom_fields&limit=5","host":["https://publicapi.myoperator.co"],"path":["contacts"],"query":[{"key":"include","value":"custom_fields"},{"key":"limit","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:45:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1559"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"303f3bba-b6bc-4149-bb25-3294f0d65070"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"1559"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"d6e7dc09-9d56-47b4-97d3-75bd13049ce7"},{"key":"x-amz-apigw-id","value":"FjmocGkLhcwEQlg="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:45:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Data\",\n \"data\": {\n \"count\": 10,\n \"next\": \"https://publicapi.myoperator.co/contacts?include=custom_fields&limit=5&offset=5\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"67a1f59b1e0abbf2e03aa40b\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"Kuldeep Malhotra\",\n \"country_code\": \"91\",\n \"phone_number\": \"7737******\",\n \"email_id\": null,\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"custom_fields\": {\n \"text\": \"VoiceTree Technologies Pvt Ltd\",\n \"text_area\": \"New Delhi, 110006, India\",\n \"secondary_number\": \"9815516XXX\",\n \"select\": \"male\",\n \"multi_select\": [\n \"python\",\n \"php\",\n \"mysql\"\n ],\n \"date\": \"2023-01-01\",\n \"date_time\": \"2023-01-01T20:11:11Z\",\n \"switch\": true\n },\n \"created\": \"2025-02-04T11:10:19.390000Z\",\n \"modified\": \"2025-02-04T11:10:19.390000Z\"\n },\n {\n \"id\": \"67a1f4e962a74787ffea12fb\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"own number\",\n \"country_code\": \"91\",\n \"phone_number\": \"7900******\",\n \"email_id\": null,\n \"marketing_opt_in\": false,\n \"status\": \"active\",\n \"custom_fields\": {\n \"text\": \"VoiceTree Technologies Pvt Ltd\",\n \"text_area\": \"New Delhi, 110006, India\",\n \"secondary_number\": \"9815516XXX\",\n \"select\": \"male\",\n \"multi_select\": [\n \"python\",\n \"php\",\n \"mysql\"\n ],\n \"date\": \"2023-01-01\",\n \"date_time\": \"2023-01-01T20:11:11Z\",\n \"switch\": true\n },\n \"created\": \"2025-02-04T11:07:21.766000Z\",\n \"modified\": \"2025-02-04T11:07:21.766000Z\"\n }\n ]\n }\n}"}],"_postman_id":"6371d484-66e2-4e5b-9011-ec4e1ff341b7"},{"name":"Fetch Contact by ID","id":"4ee1e123-2dfa-42c8-98ff-d6e7183ecc16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":"https://publicapi.myoperator.co/contacts/:id","urlObject":{"path":["contacts",":id"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[{"id":"eb522608-8298-4cbc-950e-185884886de5","type":"any","value":"{{contactid}}","key":"id"}]}},"response":[{"id":"01847232-6626-4dc6-a251-086b167a1fa3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/contacts/:id?include=custom_fields","host":["https://publicapi.myoperator.co"],"path":["contacts",":id"],"query":[{"key":"include","value":"custom_fields"}],"variable":[{"key":"id","value":"{{contactid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:53:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"347"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"5ed68440-fc7d-4d9d-b1db-590340230282"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"347"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"8b8aa781-7508-435a-bc2e-77df74efc4cb"},{"key":"x-amz-apigw-id","value":"Fjn6MF2PBcwEAsA="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:53:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Contact Fetched\",\n \"data\": {\n \"id\": \"67a1f59b1e0abbf2e03aa40b\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"Kuldeep Malhotra\",\n \"country_code\": \"91\",\n \"phone_number\": \"7737XXXXX\",\n \"email_id\": null,\n \"marketing_opt_in\": true,\n \"custom_fields\": {\n \"text\": \"VoiceTree Technologies Pvt Ltd\",\n \"text_area\": \"New Delhi, 110006, India\",\n \"secondary_number\": \"9815516XXX\",\n \"select\": \"male\",\n \"multi_select\": [\n \"python\",\n \"php\",\n \"mysql\"\n ],\n \"date\": \"2023-01-01\",\n \"date_time\": \"2023-01-01T20:11:11Z\",\n \"switch\": true\n },\n \"status\": \"active\",\n \"created\": \"2025-02-04T11:10:19.390000Z\",\n \"modified\": \"2025-02-04T11:10:19.390000Z\"\n }\n}"},{"id":"739f84ea-2197-4bb5-9330-c4de1e509927","name":"Invalid Contact ID","originalRequest":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/contacts/:id","host":["https://publicapi.myoperator.co"],"path":["contacts",":id"],"variable":[{"key":"id","value":"{{contactid}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:54:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"98e5ecbc-e8a9-4540-bf9e-3a82db658763"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"74"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"f77ff1b3-e0f8-4e81-b654-a19d3fd488ee"},{"key":"x-amz-apigw-id","value":"FjoD6G8FBcwEA_g="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:54:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"404\",\n \"message\": \"Invalid Contact ID\",\n \"errors\": {}\n}"}],"_postman_id":"4ee1e123-2dfa-42c8-98ff-d6e7183ecc16"},{"name":"Filter Contact by Phone Number","id":"ebaa7185-70ae-4add-9168-b9b843d0f103","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":"https://publicapi.myoperator.co/contacts?country_code=91&phone_number=9198765XXXXX","urlObject":{"path":["contacts"],"host":["https://publicapi.myoperator.co"],"query":[{"key":"country_code","value":"91"},{"key":"phone_number","value":"9198765XXXXX"}],"variable":[]}},"response":[{"id":"f53723f1-58a2-4ea4-b11c-0243b33b2c4a","name":"Success","originalRequest":{"method":"GET","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"url":{"raw":"https://publicapi.myoperator.co/contacts?country_code=91&phone_number=9198765XXXXX","host":["https://publicapi.myoperator.co"],"path":["contacts"],"query":[{"key":"country_code","value":"91"},{"key":"phone_number","value":"9198765XXXXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:53:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"347"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"5ed68440-fc7d-4d9d-b1db-590340230282"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"347"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"8b8aa781-7508-435a-bc2e-77df74efc4cb"},{"key":"x-amz-apigw-id","value":"Fjn6MF2PBcwEAsA="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:53:44 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Data\",\n \"data\": {\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"67a1f59b1e0abbf2e03aa40b\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"John Doe\",\n \"country_code\": \"91\",\n \"phone_number\": \"98765XXXXX\",\n \"email_id\": null,\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"created\": \"2025-02-04T11:10:19.390000Z\",\n \"modified\": \"2025-02-04T11:10:19.390000Z\"\n }\n ]\n }\n}"}],"_postman_id":"ebaa7185-70ae-4add-9168-b9b843d0f103"},{"name":"Update Contact by Phone Number","id":"3d1b048d-488b-4ad0-9eb9-fa362fd04a12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email_id\": \"hohn.doe@example.com\",\n \"marketing_opt_in\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://publicapi.myoperator.co/contacts/:phone_number_with_country_code","urlObject":{"path":["contacts",":phone_number_with_country_code"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[{"id":"7ee591d8-5912-40f0-bde1-21702d677769","type":"any","value":"9198765XXXXX","key":"phone_number_with_country_code"}]}},"response":[{"id":"1c89cd9a-f912-4e64-a948-9db5bfd0d96c","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email_id\": \"john@example.com\",\n \"custom_fields\": {\n \"text\": \"VoiceTree Technologies Pvt Ltd\",\n \"text_area\": \"New Delhi, 110006, India\",\n \"secondary_number\": \"9815516xxx\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://publicapi.myoperator.co/contacts/:phone_number_with_country_code","host":["https://publicapi.myoperator.co"],"path":["contacts",":phone_number_with_country_code"],"variable":[{"key":"phone_number_with_country_code","value":"9198765XXXXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:57:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"370"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c4bbddb1-5d8a-4297-b26c-1f76dfbf3d5b"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"370"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"709d1615-0f99-4edf-84cb-6314d7878641"},{"key":"x-amz-apigw-id","value":"FjoceGNABcwEEMQ="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:57:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Contact Updated\",\n \"data\": {\n \"id\": \"67a1f59b1e0abbf2e03aa40b\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"John Doe\",\n \"country_code\": \"91\",\n \"phone_number\": \"98765XXXXX\",\n \"email_id\": \"john@example.com\",\n \"marketing_opt_in\": true,\n \"status\": \"active\",\n \"created\": \"2025-02-04T11:10:19.390000Z\",\n \"modified\": \"2025-02-06T09:57:24.311494Z\"\n }\n}"},{"id":"68dcfdac-ba43-4c19-85a8-35bc550652db","name":"Invalid Phone Number","originalRequest":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email_id\": \"john@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://publicapi.myoperator.co/contacts/:phone_number_with_country_code","host":["https://publicapi.myoperator.co"],"path":["contacts",":phone_number_with_country_code"],"variable":[{"key":"phone_number_with_country_code","value":"Invalid_phone_number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:54:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"98e5ecbc-e8a9-4540-bf9e-3a82db658763"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"74"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"f77ff1b3-e0f8-4e81-b654-a19d3fd488ee"},{"key":"x-amz-apigw-id","value":"FjoD6G8FBcwEA_g="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:54:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"not_found\",\n \"message\": \"Not found.\",\n \"errors\": {\n \"detail\": \"Contact not found for given identifier.\"\n }\n}"},{"id":"8319cee5-8a51-4a1d-826b-7b7b9f880678","name":"Contact Doesn't Exists","originalRequest":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email_id\": \"john@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://publicapi.myoperator.co/contacts/:phone_number_with_country_code","host":["https://publicapi.myoperator.co"],"path":["contacts",":phone_number_with_country_code"],"variable":[{"key":"phone_number_with_country_code","value":"9198765XXXXX"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:54:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"74"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"98e5ecbc-e8a9-4540-bf9e-3a82db658763"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"74"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"f77ff1b3-e0f8-4e81-b654-a19d3fd488ee"},{"key":"x-amz-apigw-id","value":"FjoD6G8FBcwEA_g="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:54:45 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"not_found\",\n \"message\": \"Not found.\",\n \"errors\": {\n \"detail\": \"Contact not found for given identifier.\"\n }\n}"}],"_postman_id":"3d1b048d-488b-4ad0-9eb9-fa362fd04a12"},{"name":"Update Contact by ID","id":"fa548682-1f1a-4053-8b1c-f76d19609de9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"email_id\": \"john@example.com\",\n \"marketing_opt_in\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://publicapi.myoperator.co/contacts/:id","urlObject":{"path":["contacts",":id"],"host":["https://publicapi.myoperator.co"],"query":[],"variable":[{"id":"d021a881-b2f2-46e3-900f-0883cfad3dfe","type":"any","value":"{{contactid}}","key":"id"}]}},"response":[{"id":"4cc10288-3b65-4613-94af-62f0e87b8e0c","name":"Success","originalRequest":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Kuldeep Kumar Malhotra\",\n \"email_id\": \"kuldeep@example.com\",\n \"custom_fields\": {\n \"text\": \"VoiceTree Technologies Pvt Ltd\",\n \"text_area\": \"New Delhi, 110006, India\",\n \"secondary_number\": \"9815516xxx\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://publicapi.myoperator.co/contacts/:id","host":["https://publicapi.myoperator.co"],"path":["contacts",":id"],"variable":[{"key":"id","value":"{{contactid}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:57:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"370"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"c4bbddb1-5d8a-4297-b26c-1f76dfbf3d5b"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"370"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"709d1615-0f99-4edf-84cb-6314d7878641"},{"key":"x-amz-apigw-id","value":"FjoceGNABcwEEMQ="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:57:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"Contact Updated\",\n \"data\": {\n \"id\": \"67a1f59b1e0abbf2e03aa40b\",\n \"company_id\": \"66c595699b31d875\",\n \"name\": \"John Doe\",\n \"country_code\": \"91\",\n \"phone_number\": \"7737*****\",\n \"email_id\": \"john.doe@example.com\",\n \"marketing_opt_in\": true,\n \"custom_fields\": {\n \"text\": \"VoiceTree Technologies Pvt Ltd\",\n \"text_area\": \"New Delhi, 110006, India\",\n \"secondary_number\": \"9815516xxx\",\n \"select\": \"male\",\n \"multi_select\": [\n \"python\",\n \"php\",\n \"mysql\"\n ],\n \"date\": \"2023-01-01\",\n \"date_time\": \"2023-01-01T20:11:11Z\",\n \"switch\": true\n },\n \"status\": \"active\",\n \"created\": \"2025-02-04T11:10:19.390000Z\",\n \"modified\": \"2025-02-06T09:57:24.311494Z\"\n }\n}"},{"id":"4dec55e5-6b17-4694-93ef-c11fb34921c5","name":"Phone Number Update - Error","originalRequest":{"method":"PATCH","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"country_code\": \"91\",\n \"phone_number\": \"7737237437\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://publicapi.myoperator.co/contacts/:id","host":["https://publicapi.myoperator.co"],"path":["contacts",":id"],"variable":[{"key":"id","value":"{{contactid}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 09:58:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"116"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"5f7c59f4-5877-4769-8e83-b61e634c65c5"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=60"},{"key":"Allow","value":"GET, PATCH, DELETE, HEAD, OPTIONS"},{"key":"x-amzn-Remapped-Content-Length","value":"116"},{"key":"X-Frame-Options","value":"DENY"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-MYOP-TRACE-ID","value":"6a0a0913-d50d-4599-a49f-dcc54fcad7ce"},{"key":"x-amz-apigw-id","value":"FjooFFqPBcwEGfQ="},{"key":"x-amzn-Remapped-Server","value":"nginx"},{"key":"x-amzn-Remapped-Date","value":"Thu, 06 Feb 2025 09:58:37 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"code\": \"invalid\",\n \"message\": \"Invalid input.\",\n \"errors\": {\n \"detail\": \"Phone Number cannot be updated.\"\n }\n}"}],"_postman_id":"fa548682-1f1a-4053-8b1c-f76d19609de9"},{"name":"Delete Contact by ID","id":"16e4b11e-c2d3-4dfa-9512-1c3f5d24e3ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"X-MYOP-COMPANY-ID","value":"{{companyid}}"},{"key":"Authorization","value":"Bearer {{apikey}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://publicapi.myoperator.co/contacts/:id","description":"Delete Contact Mandatory parameter
\nThis section contains all APIs related to managing contacts.
\nThe request body should be a JSON object containing the contact's details.
\ncustom_fields ObjectThis object allows you to save data to the custom fields you have defined in your MyOperator panel.
\nThe \"key\" for each item in the custom_fields object must be the Custom Field ID.
To find this ID:
\nLogin to your MyOperator panel.
\nNavigate to Contacts -> Custom Fields.
\nClick Edit Custom Fields.
\nCopy the value from the ID column. This value is the parameter name (key) you must use in the JSON payload.
\nHere is a full example of a request body that includes various types of custom fields.
\n{\n \"name\": \"John Snow\",\n \"country_code\": \"91\",\n \"phone_number\": \"8449385515\",\n \"email_id\": \"user@example.com\",\n \"marketing_opt_in\": true,\n \"custom_fields\": {\n \"location\": \"Himachal pardesh\",\n \"address\": \"Himachal pardesh, dadh, 123456, palampur\",\n \"number\": \"1234567890\",\n \"gender\": \"male\",\n \"skills\": [\n \"python\",\n \"php\",\n \"mysql\"\n ],\n \"dob\": \"1992-04-06\",\n \"appointment_time\": \"2025-02-02 20:11:11\",\n \"local_user\": false\n }\n}\n\nNote on Custom Field Types:
As shown in the example, the custom_fields object can support different data types as values:
String: \"location\": \"Himachal pardesh\"
Number: \"number\": \"1234567890\" (as a string)
Array: \"skills\": [\"python\", \"php\", \"mysql\"]
Date: \"dob\": \"1992-04-06\"
Datetime: \"appointment_time\": \"2025-02-02 20:11:11\"
Boolean: \"local_user\": false
AfterCall Webhook enables clients to take action on the data at the end of every call. Webhook data can be used to perform the following actions at the client's end:
\nCollect call data in the datastore at the client's end.
Invoking custom integrations, such as adding a lead in the CRM.
The call log records all associated information related to the given call. After each call, we send the same log via webhooks.
{\n \"_ai\": \"5db94c34447d2410\",\n \"_so\": \"1\",\n \"_ci\": \"5c80e49d43876264\",\n \"_cr\": \"9999999999\",\n \"_cm\": \"\",\n \"_cl\": \"+919999999999\",\n \"_cy\": \"91\",\n \"_se\": \"RJ,IN\",\n \"_ts\": 1572424762,\n \"_st\": 1572424731,\n \"_ms\": 1572424731000,\n \"_ss\": 31131,\n \"_et\": 1572424755,\n \"_dr\": \"00:00:24\",\n \"_drm\": 0.4,\n \"_ty\": 1,\n \"_ev\": 1,\n \"_fn\": \"\",\n \"_fu\": \"\",\n \"_ns\": \"0\",\n \"_su\": 2,\n \"_dn\": \"Sales\",\n \"_di\": \"5c80e49e7c772564\",\n \"_pm\": [\n {\n \"ky\": \"ui\",\n \"vl\": \"test.157235dw4727.994\"\n },\n {\n \"ky\": \"is\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"vt\",\n \"vl\": \"2\"\n },\n {\n \"ky\": \"ic\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ia\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ib\",\n \"vl\": \"1\"\n }\n ],\n \"_cn\": [],\n \"_ld\": [\n {\n \"_rr\": [\n {\n \"_id\": \"5d45a342eab18943\",\n \"_na\": \"Agent 1\",\n \"_em\": \"\",\n \"_ex\": \"10\",\n \"_ct\": \"9999999999\",\n \"_nr\": \"+919999999999\"\n }\n ],\n \"_rst\": \"2019-12-04 11:22:30\",\n \"_did\": \"abcdef123\",\n \"_ds\": \"ANSWER\",\n \"_tt\": [],\n \"_su\": \"1\",\n \"_st\": 1572424745,\n \"_et\": 1572424750,\n \"_dr\": \"00:00:05\",\n \"_ac\": \"received\",\n \"_wr\": true\n }\n ],\n \"_us\": [\n {\n \"ky\": \"5d45a342eab18943\",\n \"vl\": \"received\"\n }\n ],\n \"_tc\": []\n}\n\nmyoperator={\n \"_ai\": \"5db94c34447d2410\",\n \"_so\": \"1\",\n \"_ci\": \"5c80e49d43876264\",\n \"_cr\": \"9999999999\",\n \"_cm\": \"\",\n \"_cl\": \"+919999999999\",\n \"_cy\": \"91\",\n \"_se\": \"RJ,IN\",\n \"_ts\": 1572424762,\n \"_st\": 1572424731,\n \"_ms\": 1572424731000,\n \"_ss\": 31131,\n \"_et\": 1572424755,\n \"_dr\": \"00:00:24\",\n \"_drm\": 0.4,\n \"_ty\": 1,\n \"_ev\": 1,\n \"_fn\": \"\",\n \"_fu\": \"\",\n \"_ns\": \"0\",\n \"_su\": 2,\n \"_dn\": \"Sales\",\n \"_di\": \"5c80e49e7c772564\",\n \"_pm\": [\n {\n \"ky\": \"ui\",\n \"vl\": \"test.157235dw4727.994\"\n },\n {\n \"ky\": \"is\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"vt\",\n \"vl\": \"2\"\n },\n {\n \"ky\": \"ic\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ia\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ib\",\n \"vl\": \"1\"\n }\n ],\n \"_cn\": [],\n \"_ld\": [\n {\n \"_rr\": [\n {\n \"_id\": \"5d45a342eab18943\",\n \"_na\": \"Agent 1\",\n \"_em\": \"\",\n \"_ex\": \"10\",\n \"_ct\": \"9999999999\",\n \"_nr\": \"+919999999999\"\n }\n ],\n \"_rst\": \"2019-12-04 11:22:30\",\n \"_did\": \"abcdef123\",\n \"_ds\": \"ANSWER\",\n \"_tt\": [],\n \"_su\": \"1\",\n \"_st\": 1572424745,\n \"_et\": 1572424750,\n \"_dr\": \"00:00:05\",\n \"_ac\": \"received\",\n \"_wr\": true\n }\n ],\n \"_us\": [\n {\n \"ky\": \"5d45a342eab18943\",\n \"vl\": \"received\"\n }\n ],\n \"_tc\": []\n}\n\nDisposition Webhook enables clients to take action based on the disposition data (including call data) added to the call. Webhook data can be used to do the following things at the client's end:
\nCollect call and disposition data in the datastore at the client's end.
Invoking custom integrations, such as adding a lead in the CRM.
The call log records all associated information related to the given call. After each call, we send the same log via webhooks.
{\n \"_ai\": \"5db94c34447d2410\",\n \"_so\": \"1\",\n \"_ci\": \"5c80e49d43876264\",\n \"_cr\": \"9876543210\",\n \"_cm\": \"\",\n \"_cl\": \"+919876543210\",\n \"_cy\": \"91\",\n \"_se\": \"RJ,IN\",\n \"_ts\": 1572424762,\n \"_st\": 1572424731,\n \"_ms\": 1572424731000,\n \"_ss\": 31131,\n \"_et\": 1572424755,\n \"_dr\": \"00:00:24\",\n \"_drm\": 0.4,\n \"_dsp\": [\n {\n \"_lb\": 1,\n \"_na\": \"Support\",\n \"_ag\": \"5d45a342eab18943\",\n \"_ts\": 1711091106\n },\n {\n \"_lb\": 2,\n \"_na\": \"Missed Call\",\n \"_ag\": \"5d45a342eab18943\",\n \"_ts\": 1711091106\n }\n ],\n \"_ty\": 1,\n \"_ev\": 1,\n \"_fn\": \"\",\n \"_fu\": \"\",\n \"_ns\": \"0\",\n \"_su\": 2,\n \"_dn\": \"Sales\",\n \"_di\": \"5c80e49e7c772564\",\n \"_pm\": [\n {\n \"ky\": \"ui\",\n \"vl\": \"dev1.157235dw4727.994\"\n },\n {\n \"ky\": \"is\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"vt\",\n \"vl\": \"2\"\n },\n {\n \"ky\": \"ic\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ia\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ib\",\n \"vl\": \"1\"\n }\n ],\n \"_cn\": [],\n \"_ld\": [\n {\n \"_rr\": [\n {\n \"_id\": \"5d45a342eab18943\",\n \"_na\": \"Agent 1\",\n \"_em\": \"\",\n \"_ex\": \"10\",\n \"_ct\": \"9876543210\",\n \"_nr\": \"+919876543210\"\n }\n ],\n \"_rst\": \"2019-12-04 11:22:30\",\n \"_did\": \"abcdef123\",\n \"_ds\": \"ANSWER\",\n \"_tt\": [],\n \"_su\": \"1\",\n \"_st\": 1572424745,\n \"_et\": 1572424750,\n \"_dr\": \"00:00:05\",\n \"_ac\": \"received\"\n }\n ],\n \"_us\": [\n {\n \"ky\": \"5d45a342eab18943\",\n \"vl\": \"received\"\n }\n ],\n \"_tc\": []\n}\n\nmyoperator={\n \"_ai\": \"5db94c34447d2410\",\n \"_so\": \"1\",\n \"_ci\": \"5c80e49d43876264\",\n \"_cr\": \"9876543210\",\n \"_cm\": \"\",\n \"_cl\": \"+919876543210\",\n \"_cy\": \"91\",\n \"_se\": \"RJ,IN\",\n \"_ts\": 1572424762,\n \"_st\": 1572424731,\n \"_ms\": 1572424731000,\n \"_ss\": 31131,\n \"_et\": 1572424755,\n \"_dr\": \"00:00:24\",\n \"_drm\": 0.4,\n \"_dsp\": [\n {\n \"_lb\": 1,\n \"_na\": \"Support\",\n \"_ag\": \"5d45a342eab18943\",\n \"_ts\": 1711091106\n },\n {\n \"_lb\": 2,\n \"_na\": \"Missed Call\",\n \"_ag\": \"5d45a342eab18943\",\n \"_ts\": 1711091106\n }\n ],\n \"_ty\": 1,\n \"_ev\": 1,\n \"_fn\": \"\",\n \"_fu\": \"\",\n \"_ns\": \"0\",\n \"_su\": 2,\n \"_dn\": \"Sales\",\n \"_di\": \"5c80e49e7c772564\",\n \"_pm\": [\n {\n \"ky\": \"ui\",\n \"vl\": \"dev1.157235dw4727.994\"\n },\n {\n \"ky\": \"is\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"vt\",\n \"vl\": \"2\"\n },\n {\n \"ky\": \"ic\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ia\",\n \"vl\": \"0\"\n },\n {\n \"ky\": \"ib\",\n \"vl\": \"1\"\n }\n ],\n \"_cn\": [],\n \"_ld\": [\n {\n \"_rr\": [\n {\n \"_id\": \"5d45a342eab18943\",\n \"_na\": \"Agent 1\",\n \"_em\": \"\",\n \"_ex\": \"10\",\n \"_ct\": \"9876543210\",\n \"_nr\": \"+919876543210\"\n }\n ],\n \"_rst\": \"2019-12-04 11:22:30\",\n \"_did\": \"abcdef123\",\n \"_ds\": \"ANSWER\",\n \"_tt\": [],\n \"_su\": \"1\",\n \"_st\": 1572424745,\n \"_et\": 1572424750,\n \"_dr\": \"00:00:05\",\n \"_ac\": \"received\"\n }\n ],\n \"_us\": [\n {\n \"ky\": \"5d45a342eab18943\",\n \"vl\": \"received\"\n }\n ],\n \"_tc\": []\n}\n\nWebhooks are HTTP callbacks that receive notification messages for events. MyOperator uses webhooks to notify your application anytime a call or a message event happens in your account.
\nFor example, if your agent has received a call,
\nYou will receive a webhook during the call (in-call webhook).
\nAfter the call has finished (after-call webhook)
\nAfter any disposition has been submitted (disposition webhook).
\nSimilarly, MyOperator sends the following payloads for message events:
\nMessage Sent: Triggered when any message or template is sent via Live Chat, Campaign, or API.
\nMessage Delivered: Triggered when a message or template is delivered to the customer.
\nMessage Read: Triggered when the customer reads a message or template.
\nMessage Failed: Triggered when a message or template fails to send.
\nWebhooks are delivered using the HTTP POST method.
\nWhenever a configured event occurs (such as call events or message events), MyOperator sends an HTTP POST request to your configured Target URL. The request body contains the event payload in JSON format.
\nContent-Type Support:
\nThe webhook event payload format depends on the Content-Type header configured for the webhook. The following content types are supported:
\napplication/json
\napplication/x-www-form-urlencoded
\nmultipart/form-data
\nHow data is sent for each Content-Type:
\napplication/json The complete event payload is sent as a JSON body.
\napplication/x-www-form-urlencoded The event payload fields are sent as form-encoded key-value pairs in the request body. Nested objects will be serialised appropriately within the form body.
\nmultipart/form-data The event payload fields are sent as multipart form fields in the request body.
\nIf no Content-Type is explicitly configured, the webhook event will be sent with the default Content-Type: application/json.
\nYour webhook listener should:
\nAccept HTTP POST requests
\nRead and parse the request body based on the received Content-Type header
\nReturn a 2xx status code to acknowledge successful receipt of the webhook
\nHeaders are configured as key-value pairs in the panel. Any headers configured here will be included in the HTTP request when MyOperator sends the webhook to your Target URL.
\nThis can be used for:
\nAuthenticating incoming webhook requests
\nPassing secret tokens
\nIdentifying the source of the request
\nApplying custom routing or validation logic at your server
\nFor example, you can configure a header like:
\nKey: X-Webhook-Token
Value: your-secret-token
When the webhook is delivered, MyOperator will include this header in the request. Your server can then verify the header value to ensure that the request is coming from a trusted source.
\nNotes:
\nMultiple headers can be added as key-value pairs.
\nHeader keys should follow standard HTTP header naming conventions.
\nConfigured headers are appended to every webhook request regardless of the selected Content-Type.
\nThis component allows you to configure authentication for your webhook endpoint.
\nIf your webhook listener is protected and requires authentication, you can provide the necessary credentials in this section. MyOperator will automatically include the configured authentication details when sending webhook requests.
\nSupported authentication types:
\nNo Auth
No authentication headers will be added. The webhook will be sent as a standard HTTP POST request without any credentials.
Basic Auth
Use this option if your endpoint is protected using HTTP Basic Authentication.
You can configure a username and password, and MyOperator will send the request with the appropriate Authorization: Basic header.
Example configuration:
\n {\n \"username\": \"admin\",\n \"password\": \"123456\"\n }\n\nAPI Key Auth
Use this option if your endpoint requires an API key for authentication.
The API key will be sent as a header in the webhook request using the configured key and value.
Example configuration:
\nKey: X-API-Key
\nValue: your-api-key
\nNotes:
\nAuthentication is applied to every webhook request once configured.
\nEnsure your endpoint can validate the selected authentication method.
\nIf an authentication method (Basic Auth or API Key Auth) is enabled, it will override any conflicting headers configured in the Headers section.
\nCustom headers will still be included, except in cases where they conflict with auth-related headers (e.g., Authorisation).
\nThe call log payload is included in the After-call webhook and Disposition webhook events. These webhooks are triggered after a call has ended or when a disposition is submitted by the agent.
\nThe call log contains detailed metadata about the call, such as caller information, timestamps, call status, agent details, recording information, and internal identifiers.
\nA call log is a hashmap (key-value pair) composed of several short field names with their values related to a call. The call log is provided in JSON format.
\nTo reduce payload size and bandwidth usage, the field names are intentionally kept short. Because of this, it may not always be immediately clear what each field represents. The table below describes each field along with its meaning and example values.
\n","_postman_id":"c9c47a8d-5772-4f45-96de-23d2e029ae44"},{"name":"OBD APIs","item":[{"name":"Call","id":"f20669ac-9bc2-416b-abbe-23cae133db1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"company_id\": \"The OBD Call API allows clients to initiate outbound calls through configured IVR routing.
\nCalls can be triggered using different dialer strategies depending on business workflow requirements.
\nType = 3 dialer is deprecated and no longer supported.
\nAll requests must include an API Gateway token.
\nHeader:
\nMust include country code
\nRequest throttling may apply per destination number
\nMust be unique within the configured time window
\nDuplicate reference_id results in request rejection
\nIf provided, it is echoed in all responses
\nWhen true → Request may wait for resource availability
When false\" → Request may be accepted but later cancelled if routing resources are unavailable
Maximum allowed value: 5400 seconds (90 minutes)
\nValues above limit → request rejected
\nNon-integer values → schema validation failure
\nregion(deprecated), std_code, and caller_id influence DID routing logic and are optional.
The region filter will currently work as expected. In the future, however, it will be deprecated — you can use std_code instead.
The failover campaign setting has been deprecated.
Calls are now routed by default using the DIDs mapped directly to the campaign configuration.
\nNo additional fallback campaign configuration is required.
\nIf calls must be initiated from a single specific DID, ensure that only that DID is mapped to the campaign.
\nOccurs when the request does not match the schema.
\nExamples:
\nMissing required field
\nIncorrect datatype
\nInvalid JSON structure
\nResponse format may differ from application responses.
\nOccurs when a request is structurally valid but fails business rules.
\nExamples:
\nUnauthorised source IP
\nBilling or usage expiry
\nRouting configuration not available
\nDialer type rule violations
\nThreshold limits exceeded
\nReturned when the request is successfully queued for processing.
\nA warning acceptance may be returned when routing resources are not guaranteed (e.g., call_hold disabled).
\nReturned for invalid request parameters, including:
\nMissing required fields
\nInvalid identifiers
\nInvalid number format
\nmax_call_duration violations
\nInvalid IVR configuration
\nReturned when the request is not permitted due to:
\nIP whitelist enforcement
\nUsage threshold exceeded
\nDuplicate reference_id
\nBilling expiry
\nInvalid field usage for selected dialer type
\nReturned when requested, IVR or routing configuration is not available.
\nReturned when dependent services required for call initiation are unavailable.
\nIVR must be registered beforehand.
\nProper routing configuration must exist.
\nThe call.initiated event marks the beginning of a call session.
It is the first event in the call lifecycle and indicates that the system has successfully created a call session. This event is always emitted before any dialing or routing begins.
\nThis webhook follows the standard envelope + payload structure:
\nRoot fields contain event metadata (routing, identification, sequencing)
\npayload contains event-specific data
The payload for call.initiated is minimal and only contains the call start timestamp.
{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-6576745f83b89afa7558e57ec7e7d692a9164f93b62c93eb68ac8c1676fd7eb71bbc14c8\",\n\"event_type\": \"call.initiated\",\n\"event_sequence\": 1922,\n\"event_version\": \"1\",\n\"timestamp\": \"2026-04-07T10:03:23.895577463Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"stage2.1775556203.2115\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919570350910\",\n\"payload\": {\n \"started_at\": \"2026-04-07T10:03:23.738Z\"\n}\n}\n\nThe call.dial_begin event represents the stage where the system starts dialing a participant (agent or customer).
This event provides detailed information about the dialing process through the legs array.
This webhook follows the standard envelope + payload structure:
\nRoot fields contain event metadata (routing, identification, sequencing)
\npayload contains call routing and participant details
The payload contains a legs array describing participants involved in dialing
If no second party is involved (e.g., IVR-only flow or missed call), this event may not be triggered
\nThe legs array may be empty in case of missed calls or misdials
Incoming call → leg1 = customer, leg2 = agent
\nOneway call → leg1 = agent, leg2 = customer
\nCallback call → leg1 = agent/customer, leg2 = customer/agent
\nWebcall outgoing → leg1 = agent, leg2 = customer
\nOBD (agent first) → leg1 = agent, leg2 = customer
\nOBD (customer first) → leg1 = customer, leg2 = agent
\nOTP call → No event generated
\nThe following examples show complete webhook payloads for different call scenarios.
\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-incoming-1\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1001,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-12-23T12:21:31.978Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"session.incoming.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+917906225789\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917906225789\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"answered_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ended_at\": null,\n \"ring_duration\": null,\n \"talk_duration\": 26\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919873641288\",\n \"pickup_device\": \"phone\",\n \"result\": \"dialing\",\n \"started_at\": \"2025-12-23T12:21:31.978Z\",\n \"answered_at\": null,\n \"dept_id\": \"dept123\",\n \"dial_status\": \"\",\n \"ended_at\": null,\n \"ring_duration\": null,\n \"talk_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-extension-1\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1002,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-12-23T12:21:31.978Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"session.extension.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+917906225789\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917906225789\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"answered_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ended_at\": null,\n \"ring_duration\": null,\n \"talk_duration\": 26\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919873641288\",\n \"pickup_device\": \"phone\",\n \"result\": \"dialing\",\n \"started_at\": \"2025-12-23T12:21:31.978Z\",\n \"answered_at\": null,\n \"dept_id\": \"extension\",\n \"dial_status\": \"\",\n \"ended_at\": null,\n \"ring_duration\": null,\n \"talk_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-oneway-1\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1003,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T13:15:46.555Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.oneway.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919570350910\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+917779812955\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-11-28T13:15:45.430Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ring_duration\": null,\n \"talk_duration\": 1\n },\n {\n \"leg_index\": 2,\n \"type\": \"customer\",\n \"phone_number\": \"+919570350910\",\n \"pickup_device\": \"phone\",\n \"result\": \"dialing\",\n \"started_at\": \"2025-11-28T13:15:46.555Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ring_duration\": null,\n \"talk_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-obd-agent-first-1\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1004,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T09:27:40.237Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.agent.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+918368782690\",\n \"dial_status\": \"\",\n \"result\": \"dialing\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:40.237Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"talk_duration\": null,\n \"ring_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-obd-agent-first-2\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1005,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T09:27:57.713Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.agent.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919990094254\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+918368782690\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:40.237Z\",\n \"answered_at\": \"2025-11-28T09:27:56.784Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 16\n },\n {\n \"leg_index\": 2,\n \"type\": \"customer\",\n \"phone_number\": \"+919990094254\",\n \"dial_status\": \"\",\n \"result\": \"dialing\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:57.713Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"talk_duration\": null,\n \"ring_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-obd-customer-first-1\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1006,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-27T09:31:11.382Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.customer.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919873939342\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+919873939342\",\n \"dial_status\": \"\",\n \"result\": \"dialing\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:11.382Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"talk_duration\": null,\n \"ring_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-obd-customer-first-2\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1007,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-27T09:31:20.908Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.customer.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919873939342\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+919873939342\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:11.382Z\",\n \"answered_at\": \"2025-11-27T09:31:18.066Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 6\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919990094254\",\n \"dial_status\": \"\",\n \"result\": \"dialing\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:20.908Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"talk_duration\": null,\n \"ring_duration\": null\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-obd-ivr-1\",\n\"event_type\": \"call.dial_begin\",\n\"event_sequence\": 1008,\n\"event_version\": \"1\",\n\"timestamp\": \"2026-01-23T08:12:22.451Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.ivr.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+917290016463\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917290016463\",\n \"dial_status\": \"\",\n \"result\": \"dialing\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2026-01-23T08:12:22.451Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"talk_duration\": null,\n \"ring_duration\": null\n }\n ]\n}\n}\n\nThe call.answered event is triggered when a participant (agent or customer) answers the call.
This event provides details about the participant who answered, along with the current state of all call legs.
\nThis webhook follows the standard envelope + payload structure:
\nRoot fields contain event metadata (routing, identification, sequencing)
\npayload contains call participant details
The payload contains a legs array representing all participants involved in the call.
The leg with result = answered indicates the participant who just answered
Other legs represent the current state of the call
\nThe following examples show complete webhook payloads for different call scenarios.
\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-incoming-1\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2001,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-12-23T12:21:41.822Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"session.incoming.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+917906225789\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917906225789\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"answered_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ended_at\": null,\n \"ring_duration\": null,\n \"talk_duration\": 36\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919873641288\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"started_at\": \"2025-12-23T12:21:31.978Z\",\n \"answered_at\": \"2025-12-23T12:21:41.822Z\",\n \"ring_duration\": 9,\n \"dept_id\": \"dept123\",\n \"dial_status\": \"ANSWER\",\n \"ended_at\": null,\n \"talk_duration\": 0\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-extension-1\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2002,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-12-23T12:21:41.822Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"session.extension.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+917906225789\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917906225789\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"answered_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ended_at\": null,\n \"ring_duration\": null,\n \"talk_duration\": 36\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919873641288\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"started_at\": \"2025-12-23T12:21:31.978Z\",\n \"answered_at\": \"2025-12-23T12:21:41.822Z\",\n \"ring_duration\": 9,\n \"dept_id\": \"extension\",\n \"dial_status\": \"ANSWER\",\n \"ended_at\": null,\n \"talk_duration\": 0\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-oneway-1\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2003,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T13:15:52.907Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.oneway.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919570350910\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+917779812955\",\n \"dial_status\": \"\",\n \"result\": \"connected\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T13:15:45.430Z\",\n \"answered_at\": null,\n \"ended_at\": null,\n \"talk_duration\": 7,\n \"ring_duration\": null\n },\n {\n \"leg_index\": 2,\n \"type\": \"customer\",\n \"phone_number\": \"+919570350910\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T13:15:46.555Z\",\n \"answered_at\": \"2025-11-28T13:15:52.907Z\",\n \"ended_at\": null,\n \"ring_duration\": 6,\n \"talk_duration\": 0\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-obd-agent-1\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2004,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T09:27:56.784Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.agent.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+918368782690\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:40.237Z\",\n \"answered_at\": \"2025-11-28T09:27:56.784Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 16\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-obd-agent-2\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2005,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T09:27:58.507Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.agent.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919990094254\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+918368782690\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:40.237Z\",\n \"answered_at\": \"2025-11-28T09:27:56.784Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 16\n },\n {\n \"leg_index\": 2,\n \"type\": \"customer\",\n \"phone_number\": \"+919990094254\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:57.713Z\",\n \"answered_at\": \"2025-11-28T09:27:58.507Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 0\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-obd-customer-1\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2006,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-27T09:31:18.066Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.customer.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919873939342\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+919873939342\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:11.382Z\",\n \"answered_at\": \"2025-11-27T09:31:18.066Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 6\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-obd-customer-2\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2007,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-27T09:31:26.420Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.customer.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+919873939342\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+919873939342\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:11.382Z\",\n \"answered_at\": \"2025-11-27T09:31:18.066Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 6\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919990094254\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:20.908Z\",\n \"answered_at\": \"2025-11-27T09:31:26.420Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 5\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-answered-obd-ivr-1\",\n\"event_type\": \"call.answered\",\n\"event_sequence\": 2008,\n\"event_version\": \"1\",\n\"timestamp\": \"2026-01-23T08:12:34.215Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.ivr.1\",\n\"system_identifier\": \"+911206544522\",\n\"customer_identifier\": \"+917290016463\",\n\"payload\": {\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917290016463\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2026-01-23T08:12:22.451Z\",\n \"answered_at\": \"2026-01-23T08:12:34.215Z\",\n \"ended_at\": null,\n \"talk_duration\": 0,\n \"ring_duration\": 11\n }\n ]\n}\n}\n\nThe call.end event represents the final state of a call.
It contains the complete call summary, including all historical data related to the call and every leg involved. This is the final event for a call session.
\nThis webhook follows the standard envelope + payload structure:
\nRoot fields contain event metadata
\npayload contains the complete call summary
The payload object for call.end contains:
All top-level call fields
\nComplete legs array with final state of all participants
{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-end-incoming-1\",\n\"event_type\": \"call.end\",\n\"event_sequence\": 3001,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-12-23T12:21:48.962Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"s4.1766492465.1359\",\n\"system_identifier\": \"+911206544510\",\n\"customer_identifier\": \"+917906225789\",\n\"payload\": {\n \"id\": \"s4.1766492465.1359\",\n \"did\": \"+911206544510\",\n \"direction\": \"incoming\",\n \"customer_number\": \"+917906225789\",\n \"status\": \"bridged\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"ended_at\": \"2025-12-23T12:21:48.962Z\",\n \"category\": \"incoming\",\n \"duration\": 43,\n \"recording_filename\": \"5228226174b1fbe77a2ab23e7be2dd3560c859d4b10e98a9c2d0f02437ec42676faf05fbe832a174e843bea00693867f-v2.mp3\",\n \"billable\": true,\n \"ref_id\": \"\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": null,\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917906225789\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"ended_at\": \"2025-12-23T12:21:48.962Z\",\n \"answered_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ring_duration\": null,\n \"talk_duration\": 43\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919873641288\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"dept123\",\n \"started_at\": \"2025-12-23T12:21:31.978Z\",\n \"answered_at\": \"2025-12-23T12:21:41.822Z\",\n \"ended_at\": \"2025-12-23T12:21:48.183Z\",\n \"talk_duration\": 6,\n \"ring_duration\": 9\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-end-incoming-ext-1\",\n\"event_type\": \"call.end\",\n\"event_sequence\": 3002,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-12-23T12:21:48.962Z\",\n\"channel\": \"call\",\n\"direction\": \"incoming\",\n\"session_id\": \"s4.1766492465.1359\",\n\"system_identifier\": \"+911206544510\",\n\"customer_identifier\": \"+917906225789\",\n\"payload\": {\n \"id\": \"s4.1766492465.1359\",\n \"did\": \"+911206544510\",\n \"direction\": \"incoming\",\n \"customer_number\": \"+917906225789\",\n \"status\": \"bridged\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"ended_at\": \"2025-12-23T12:21:48.962Z\",\n \"category\": \"incoming\",\n \"duration\": 43,\n \"recording_filename\": \"5228226174b1fbe77a2ab23e7be2dd3560c859d4b10e98a9c2d0f02437ec42676faf05fbe832a174e843bea00693867f-v2.mp3\",\n \"billable\": true,\n \"ref_id\": \"\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": null,\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917906225789\",\n \"pickup_device\": \"phone\",\n \"result\": \"connected\",\n \"started_at\": \"2025-12-23T12:21:05.779Z\",\n \"ended_at\": \"2025-12-23T12:21:48.962Z\",\n \"answered_at\": null,\n \"dept_id\": \"\",\n \"dial_status\": \"\",\n \"ring_duration\": null,\n \"talk_duration\": 43\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919873641288\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"extension\",\n \"started_at\": \"2025-12-23T12:21:31.978Z\",\n \"answered_at\": \"2025-12-23T12:21:41.822Z\",\n \"ended_at\": \"2025-12-23T12:21:48.183Z\",\n \"talk_duration\": 6,\n \"ring_duration\": 9\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-end-oneway-1\",\n\"event_type\": \"call.end\",\n\"event_sequence\": 3002,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T13:16:01.989Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.oneway.1\",\n\"system_identifier\": \"+912269659535\",\n\"customer_identifier\": \"+919570350910\",\n\"payload\": {\n \"id\": \"s4.1764335745.526\",\n \"did\": \"+912269659535\",\n \"customer_number\": \"+919570350910\",\n \"category\": \"oneway\",\n \"direction\": \"outgoing\",\n \"status\": \"bridged\",\n \"started_at\": \"2025-11-28T13:15:45.430Z\",\n \"ended_at\": \"2025-11-28T13:16:01.989Z\",\n \"duration\": 16,\n \"billable\": true,\n \"ref_id\": \"\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": null,\n \"recording_filename\": \"8b0f4f4adf9ea027e997d79c1c4ebbef00c32f1fae7c413b0b9fe09b471426e4002b631bf50b8806e843bea00693867f-v2.mp3\",\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+917779812955\",\n \"dial_status\": \"\",\n \"result\": \"connected\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T13:15:45.430Z\",\n \"answered_at\": null,\n \"ended_at\": \"2025-11-28T13:16:01.989Z\",\n \"talk_duration\": 16,\n \"ring_duration\": null\n },\n {\n \"leg_index\": 2,\n \"type\": \"customer\",\n \"phone_number\": \"+919570350910\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T13:15:46.555Z\",\n \"answered_at\": \"2025-11-28T13:15:52.907Z\",\n \"ended_at\": \"2025-11-28T13:16:00.682Z\",\n \"talk_duration\": 7,\n \"ring_duration\": 6\n }\n ]\n}\n}\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-end-obd-agent-1\",\n\"event_type\": \"call.end\",\n\"event_sequence\": 3003,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-28T09:28:19.119Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.agent.1\",\n\"system_identifier\": \"+912269659535\",\n\"customer_identifier\": \"+919990094254\",\n\"payload\": {\n \"id\": \"s4.1764322060.478\",\n \"did\": \"+912269659535\",\n \"customer_number\": \"+919990094254\",\n \"category\": \"outgoing\",\n \"direction\": \"outgoing\",\n \"status\": \"bridged\",\n \"started_at\": \"2025-11-28T09:27:40.235Z\",\n \"ended_at\": \"2025-11-28T09:28:19.119Z\",\n \"duration\": 38,\n \"billable\": true,\n \"ref_id\": \"7890c470-cc3c-11f0-9432-f7e9b3b009e3\",\n \"client_ref_id\": \"abee0de9-0c1c-4760-863c-f8f198b7f230\",\n \"obd_campaign\": {\n \"id\": \"670f929754225347\",\n \"job_id\": \"\"\n },\n \"recording_filename\": \"8b0f4f4adf9ea027e997d79c1c4ebbef00c32f1fae7c413b745dc5fafb8bdd81cdb0703bfc8fa892e843bea00693867f-v2.mp3\",\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"agent\",\n \"phone_number\": \"+918368782690\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:40.237Z\",\n \"answered_at\": \"2025-11-28T09:27:56.784Z\",\n \"ended_at\": \"2025-11-28T09:28:18.883Z\",\n \"talk_duration\": 22,\n \"ring_duration\": 16\n },\n {\n \"leg_index\": 2,\n \"type\": \"customer\",\n \"phone_number\": \"+919990094254\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-28T09:27:57.713Z\",\n \"answered_at\": \"2025-11-28T09:27:58.507Z\",\n \"ended_at\": \"2025-11-28T09:28:17.235Z\",\n \"talk_duration\": 18,\n \"ring_duration\": 0\n }\n ]\n}\n}\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-end-obd-customer-1\",\n\"event_type\": \"call.end\",\n\"event_sequence\": 3004,\n\"event_version\": \"1\",\n\"timestamp\": \"2025-11-27T09:31:37.119Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.customer.1\",\n\"system_identifier\": \"+912269659514\",\n\"customer_identifier\": \"+919873939342\",\n\"payload\": {\n \"id\": \"s4.1764235871.416\",\n \"did\": \"+912269659514\",\n \"customer_number\": \"+919873939342\",\n \"category\": \"outgoing\",\n \"direction\": \"outgoing\",\n \"status\": \"bridged\",\n \"started_at\": \"2025-11-27T09:31:11.380Z\",\n \"ended_at\": \"2025-11-27T09:31:37.119Z\",\n \"duration\": 25,\n \"billable\": true,\n \"ref_id\": \"cd6365cf-cb73-11f0-8490-c152c19f0358\",\n \"client_ref_id\": \"43ec47a8-344d-4bc5-837b-75cddd7295ee\",\n \"obd_campaign\": {\n \"id\": \"61c2b71197846913\",\n \"job_id\": \"\"\n },\n \"recording_filename\": \"225a7ca346424d20ad00cb253ba3629500c32f1fae7c413bfd3df40126c3e468050e6c7f25b80682e843bea00693867f-v2.mp3\",\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+919873939342\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:11.382Z\",\n \"answered_at\": \"2025-11-27T09:31:18.066Z\",\n \"ended_at\": \"2025-11-27T09:31:36.739Z\",\n \"talk_duration\": 18,\n \"ring_duration\": 6\n },\n {\n \"leg_index\": 2,\n \"type\": \"agent\",\n \"phone_number\": \"+919990094254\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2025-11-27T09:31:20.908Z\",\n \"answered_at\": \"2025-11-27T09:31:26.420Z\",\n \"ended_at\": \"2025-11-27T09:31:35.097Z\",\n \"talk_duration\": 8,\n \"ring_duration\": 5\n }\n ]\n}\n}\n\n{\n\"company_id\": \"6836cad944e39380\",\n\"event_id\": \"event-end-obd-ivr-1\",\n\"event_type\": \"call.end\",\n\"event_sequence\": 3005,\n\"event_version\": \"1\",\n\"timestamp\": \"2026-01-23T08:12:51.560Z\",\n\"channel\": \"call\",\n\"direction\": \"outgoing\",\n\"session_id\": \"session.obd.ivr.1\",\n\"system_identifier\": \"+911206544518\",\n\"customer_identifier\": \"+917290016463\",\n\"payload\": {\n \"id\": \"s4.1769155942.259\",\n \"did\": \"+911206544518\",\n \"customer_number\": \"+917290016463\",\n \"category\": \"outgoing\",\n \"direction\": \"outgoing\",\n \"status\": \"missed\",\n \"started_at\": \"2026-01-23T08:12:22.450Z\",\n \"ended_at\": \"2026-01-23T08:12:51.560Z\",\n \"duration\": 29,\n \"billable\": true,\n \"ref_id\": \"3a687048-f833-11f0-9f08-538f72b1b9fa\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": {\n \"id\": \"68623ff4e1483554\",\n \"job_id\": \"\"\n },\n \"recording_filename\": \"\",\n \"legs\": [\n {\n \"leg_index\": 1,\n \"type\": \"customer\",\n \"phone_number\": \"+917290016463\",\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"pickup_device\": \"phone\",\n \"dept_id\": \"\",\n \"started_at\": \"2026-01-23T08:12:22.451Z\",\n \"answered_at\": \"2026-01-23T08:12:34.215Z\",\n \"ended_at\": \"2026-01-23T08:12:51.110Z\",\n \"talk_duration\": 16,\n \"ring_duration\": 11\n }\n ]\n}\n}\n\nThe call.summary event is the final event in the call lifecycle.
It contains the complete and enriched call log, including:
\nFinal call details
\nAll participants (legs)
\nAgent and department metadata
\nComments added during the call
\nThis is the most comprehensive event for a session and should be used for:
\nCRM updates
\nAnalytics
\nReporting
\nFinal state processing
\nThis webhook follows the standard envelope + payload structure:
\nRoot fields contain event metadata
\npayload contains the complete call summary
The payload object contains:
\nAll top-level call fields
\nFull legs array (never empty)
comments array (if any comments were added)
Additional metadata such as agent and department details
\nIn addition to fields present in call.end, each leg includes:
The following examples represent different call flows and may vary based on routing and configuration.
\n{\n \"company_id\": \"6836cad944e39380\",\n \"event_id\": \"event-6576745f8fafabe9313e5e2bd3b9dcab6836d4c0e7bc496954a667b30c6fd0cbdfce00b8\",\n \"event_type\": \"call.summary\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-14T05:29:28.838594394Z\",\n \"channel\": \"call\",\n \"direction\": \"incoming\",\n \"session_id\": \"15.1776144484.2922\",\n \"system_identifier\": \"\",\n \"customer_identifier\": \"+919876543210\",\n \"payload\": {\n \"id\": \"15.1776144484.2922\",\n \"direction\": \"incoming\",\n \"customer_number\": \"+919876543210\",\n \"status\": \"bridged\",\n \"started_at\": \"2026-04-14T05:28:04+00:00\",\n \"ended_at\": \"2026-04-14T05:29:26+00:00\",\n \"category\": \"incoming\",\n \"location\": \"KO, IN\",\n \"duration\": 82,\n \"recording_filename\": \"7b8aff8e25f29185454c0692961dab4760c859d4b10e98a9607147ede94c12e1775ebf48d8d4cb89e843bea00693867f-v2.mp3\",\n \"ref_id\": \"\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": null,\n \"legs\": [\n {\n \"leg_index\": 1,\n \"agent\": null,\n \"dial_status\": \"\",\n \"result\": \"connected\",\n \"department\": {\n \"id\": \"6836e64613c33702\",\n \"name\": \"Technical Department\"\n },\n \"started_at\": \"2026-04-14T05:28:04+00:00\",\n \"ended_at\": \"2026-04-14T05:29:26+00:00\",\n \"talk_duration\": 82,\n \"phone_number\": \"+919876543210\",\n \"type\": \"customer\",\n \"pickup_device\": \"phone\",\n \"answered_at\": null,\n \"ring_duration\": null\n },\n {\n \"leg_index\": 2,\n \"agent\": {\n \"uuid\": \"6836cad947bcc605\",\n \"name\": \"Agent1 Name\",\n \"email\": \"xyz@email.com\",\n \"contact\": \"+911234567890\",\n \"extension\": \"10\"\n },\n \"dial_status\": \"BUSY\",\n \"result\": \"not_answered\",\n \"department\": {\n \"id\": \"6836e64613c33702\",\n \"name\": \"Technical Department\"\n },\n \"started_at\": \"2026-04-14T05:28:22+00:00\",\n \"ended_at\": \"2026-04-14T05:28:44+00:00\",\n \"talk_duration\": null,\n \"phone_number\": \"+911234567890\",\n \"type\": \"agent\",\n \"pickup_device\": \"phone\",\n \"answered_at\": null,\n \"ring_duration\": 22\n },\n {\n \"leg_index\": 3,\n \"agent\": {\n \"uuid\": \"69d4d6bb5ffa3909\",\n \"name\": \"Agent2 Name\",\n \"email\": null,\n \"contact\": \"+913214567890\",\n \"extension\": \"15\"\n },\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": {\n \"id\": \"6836e64613c33702\",\n \"name\": \"Technical Department\"\n },\n \"started_at\": \"2026-04-14T05:28:47+00:00\",\n \"ended_at\": \"2026-04-14T05:29:25+00:00\",\n \"talk_duration\": 26,\n \"phone_number\": \"+913214567890\",\n \"type\": \"agent\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-14T05:28:59+00:00\",\n \"ring_duration\": 12\n }\n ],\n \"billable\": true,\n \"comments\": []\n }\n}\n\n{\n \"company_id\": \"6836cad944e39380\",\n \"event_id\": \"event-6576745fd343e02daa21861039a8dda8ad6ec7b86c652e0e0573706047b05d4ee8d5063a\",\n \"event_type\": \"call.summary\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-09T12:05:56.337709015Z\",\n \"channel\": \"call\",\n \"direction\": \"outgoing\",\n \"session_id\": \"15.1775736313.2516\",\n \"system_identifier\": \"\",\n \"customer_identifier\": \"+911234567890\",\n \"payload\": {\n \"id\": \"15.1775736313.2516\",\n \"direction\": \"outgoing\",\n \"customer_number\": \"+911234567890\",\n \"status\": \"bridged\",\n \"started_at\": \"2026-04-09T12:05:14+00:00\",\n \"ended_at\": \"2026-04-09T12:05:51+00:00\",\n \"category\": \"oneway\",\n \"location\": \"DL, IN\",\n \"duration\": 37,\n \"recording_filename\": \"7b8aff8e25f29185454c0692961dab4760c859d4b10e98a9d4ae047dc4fcf8512e446f1527055513e843bea00693867f-v2.mp3\",\n \"ref_id\": \"\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": null,\n \"legs\": [\n {\n \"leg_index\": 1,\n \"agent\": {\n \"uuid\": \"6836cad947bcc605\",\n \"name\": \"Agent Name\",\n \"email\": \"xyz@gmail.com\",\n \"contact\": \"+919876543210\",\n \"extension\": \"10\"\n },\n \"dial_status\": \"\",\n \"result\": \"connected\",\n \"department\": null,\n \"started_at\": \"2026-04-09T12:05:14+00:00\",\n \"ended_at\": \"2026-04-09T12:05:51+00:00\",\n \"talk_duration\": 37,\n \"phone_number\": \"+919876543210\",\n \"type\": \"agent\",\n \"pickup_device\": \"phone\",\n \"answered_at\": null,\n \"ring_duration\": null\n },\n {\n \"leg_index\": 2,\n \"agent\": null,\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": null,\n \"started_at\": \"2026-04-09T12:05:16+00:00\",\n \"ended_at\": \"2026-04-09T12:05:50+00:00\",\n \"talk_duration\": 20,\n \"phone_number\": \"+911234567890\",\n \"type\": \"customer\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-09T12:05:30+00:00\",\n \"ring_duration\": 14\n }\n ],\n \"billable\": true,\n \"comments\": []\n }\n}\n\n{\n \"company_id\": \"68639de9580b6744\",\n \"event_id\": \"event-6576745f792d42afcc1cf4ab7da4dd4ed13f53b5e3a687947876b54356e54aa16dc5fdbd\",\n \"event_type\": \"call.summary\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-24T07:10:07.194671292Z\",\n \"channel\": \"call\",\n \"direction\": \"outgoing\",\n \"session_id\": \"cm3.1777014573.696689\",\n \"system_identifier\": \"\",\n \"customer_identifier\": \"+911234567890\",\n \"payload\": {\n \"id\": \"cm3.1777014573.696689\",\n \"direction\": \"outgoing\",\n \"customer_number\": \"+911234567890\",\n \"status\": \"bridged\",\n \"started_at\": \"2026-04-24T07:09:33+00:00\",\n \"ended_at\": \"2026-04-24T07:10:07+00:00\",\n \"category\": \"obd\",\n \"location\": \"DL, IN\",\n \"duration\": 34,\n \"recording_filename\": \"808f5a09060e018b7f33f335b4515b189a2830bac09c6f99586528f7548d0f0225366960900a4781e843bea00693867f-v2.mp3\",\n \"ref_id\": \"882a6425-3fac-11f1-800e-e762d0e4cc6e\",\n \"client_ref_id\": \"108549bb-3fe0-4862-8afb-35c747ee1be3\",\n \"obd_campaign\": {\n \"id\": \"6981d1c6c99f8650\",\n \"job_id\": \"\"\n },\n \"legs\": [\n {\n \"leg_index\": 1,\n \"agent\": {\n \"uuid\": \"68baab1d30e05351\",\n \"name\": \"Agent Name\",\n \"email\": \"xyz@email.com\",\n \"contact\": \"+911234567890\",\n \"extension\": \"14\"\n },\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": null,\n \"started_at\": \"2026-04-24T07:09:33+00:00\",\n \"ended_at\": \"2026-04-24T07:10:07+00:00\",\n \"talk_duration\": 28,\n \"phone_number\": \"+911234567890\",\n \"type\": \"agent\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-24T07:09:39+00:00\",\n \"ring_duration\": 6\n },\n {\n \"leg_index\": 2,\n \"agent\": null,\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": null,\n \"started_at\": \"2026-04-24T07:09:39+00:00\",\n \"ended_at\": \"2026-04-24T07:10:05+00:00\",\n \"talk_duration\": 8,\n \"phone_number\": \"+911234567890\",\n \"type\": \"customer\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-24T07:09:57+00:00\",\n \"ring_duration\": 18\n }\n ],\n \"billable\": true,\n \"comments\": []\n }\n}\n\n{\n \"company_id\": \"68639de9580b6744\",\n \"event_id\": \"event-6576745f700318ac2e73e20b37b439658060eaf977cfb9b1fbd04456ff28ccb89e698bd6\",\n \"event_type\": \"call.summary\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-24T07:19:24.817138767Z\",\n \"channel\": \"call\",\n \"direction\": \"outgoing\",\n \"session_id\": \"cm3.1777015136.696726\",\n \"system_identifier\": \"\",\n \"customer_identifier\": \"+919876543210\",\n \"payload\": {\n \"id\": \"cm3.1777015136.696726\",\n \"direction\": \"outgoing\",\n \"customer_number\": \"+919876543210\",\n \"status\": \"bridged\",\n \"started_at\": \"2026-04-24T07:18:57+00:00\",\n \"ended_at\": \"2026-04-24T07:19:25+00:00\",\n \"category\": \"obd\",\n \"location\": \"DL, IN\",\n \"duration\": 28,\n \"recording_filename\": \"808f5a09060e018b7f33f335b4515b189a2830bac09c6f997b57e94d57e7d278aca5a49c4c51a58ce843bea00693867f-v2.mp3\",\n \"ref_id\": \"d852f747-3fad-11f1-9d0b-e198ec2900fc\",\n \"client_ref_id\": \"aa5b43bd-d4e6-442a-99e6-1e00407f49eb\",\n \"obd_campaign\": {\n \"id\": \"6981d1c6c99f8650\",\n \"job_id\": \"\"\n },\n \"legs\": [\n {\n \"leg_index\": 1,\n \"agent\": null,\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": null,\n \"started_at\": \"2026-04-24T07:18:57+00:00\",\n \"ended_at\": \"2026-04-24T07:19:24+00:00\",\n \"talk_duration\": 17,\n \"phone_number\": \"+919876543210\",\n \"type\": \"customer\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-24T07:19:07+00:00\",\n \"ring_duration\": 10\n },\n {\n \"leg_index\": 2,\n \"agent\": {\n \"uuid\": \"68baab1d30e05351\",\n \"name\": \"Agent Name\",\n \"email\": \"xyz@email.com\",\n \"contact\": \"+911234567890\",\n \"extension\": \"14\"\n },\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": null,\n \"started_at\": \"2026-04-24T07:19:08+00:00\",\n \"ended_at\": \"2026-04-24T07:19:23+00:00\",\n \"talk_duration\": 6,\n \"phone_number\": \"+911234567890\",\n \"type\": \"agent\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-24T07:19:17+00:00\",\n \"ring_duration\": 9\n }\n ],\n \"billable\": true,\n \"comments\": []\n }\n}\n{\n \"company_id\": \"6836cad944e39380\",\n \"event_id\": \"event-6576745f2ea118ea5f2f9117da0242bd5ad4f24c2a2ff95a53cee0f9b04c9617750e863a\",\n \"event_type\": \"call.summary\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-06T06:51:19.316407825Z\",\n \"channel\": \"call\",\n \"direction\": \"incoming\",\n \"session_id\": \"13.1775458243.1907\",\n \"system_identifier\": \"\",\n \"customer_identifier\": \"+919876543210\",\n \"payload\": {\n \"id\": \"13.1775458243.1907\",\n \"direction\": \"incoming\",\n \"customer_number\": \"+919876543210\",\n \"status\": \"bridged\",\n \"started_at\": \"2026-04-06T06:50:44+00:00\",\n \"ended_at\": \"2026-04-06T06:51:18+00:00\",\n \"category\": \"incoming\",\n \"location\": \"BR, IN\",\n \"duration\": 34,\n \"recording_filename\": \"7b8aff8e25f29185454c0692961dab4760c859d4b10e98a9f86dc79de7bc04aa81defe42650c60fce843bea00693867f-v2.mp3\",\n \"ref_id\": \"\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": {\n \"id\": \"\",\n \"job_id\": \"\"\n },\n \"legs\": [\n {\n \"leg_index\": 1,\n \"agent\": null,\n \"dial_status\": \"\",\n \"result\": \"connected\",\n \"department\": {\n \"id\": \"6836cad949b0a207\",\n \"name\": \"Extension Directory\"\n },\n \"started_at\": \"2026-04-06T06:50:44+00:00\",\n \"ended_at\": \"2026-04-06T06:51:18+00:00\",\n \"talk_duration\": 34,\n \"phone_number\": \"+919876543210\",\n \"type\": \"customer\",\n \"pickup_device\": \"phone\",\n \"answered_at\": null,\n \"ring_duration\": null\n },\n {\n \"leg_index\": 2,\n \"agent\": {\n \"uuid\": \"685a68e97f0bb409\",\n \"name\": \"Agent Name\",\n \"email\": \"\",\n \"contact\": \"+911234567890\",\n \"extension\": \"11\"\n },\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": {\n \"id\": \"6836cad949b0a207\",\n \"name\": \"Extension Directory\"\n },\n \"started_at\": \"2026-04-06T06:51:03+00:00\",\n \"ended_at\": \"2026-04-06T06:51:17+00:00\",\n \"talk_duration\": 10,\n \"phone_number\": \"+911234567890\",\n \"type\": \"agent\",\n \"pickup_device\": \"web\",\n \"answered_at\": \"2026-04-06T06:51:07+00:00\",\n \"ring_duration\": 4\n }\n ],\n \"billable\": true,\n \"comments\": []\n }\n}\n\n{\n \"company_id\": \"68639de9580b6744\",\n \"event_id\": \"event-6576745f4d87eb40b76a3b15ee86e81f663b75dac0c61eb1d4ab88d0f04600d83147bd33\",\n \"event_type\": \"call.summary\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-24T07:25:03.332495161Z\",\n \"channel\": \"call\",\n \"direction\": \"outgoing\",\n \"session_id\": \"d6.1777015462.4686492\",\n \"system_identifier\": \"\",\n \"customer_identifier\": \"+919876543210\",\n \"payload\": {\n \"id\": \"d6.1777015462.4686492\",\n \"direction\": \"outgoing\",\n \"customer_number\": \"+919876543210\",\n \"status\": \"bridged\",\n \"started_at\": \"2026-04-24T07:24:23+00:00\",\n \"ended_at\": \"2026-04-24T07:25:04+00:00\",\n \"category\": \"obd\",\n \"location\": \"DL, IN\",\n \"duration\": 41,\n \"recording_filename\": \"808f5a09060e018b7f33f335b4515b1857e466302f182909b4f46c4eafce8bd2dd1cfce521b1a53de843bea00693867f-v2.mp3\",\n \"ref_id\": \"9b3ecceb-3fae-11f1-b40a-4775a6074327\",\n \"client_ref_id\": \"\",\n \"obd_campaign\": {\n \"id\": \"6866272fd92b9926\",\n \"job_id\": \"\"\n },\n \"legs\": [\n {\n \"leg_index\": 1,\n \"agent\": null,\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": {\n \"id\": \"68639de95bad6808\",\n \"name\": \"Extension Directory\"\n },\n \"started_at\": \"2026-04-24T07:24:23+00:00\",\n \"ended_at\": \"2026-04-24T07:25:03+00:00\",\n \"talk_duration\": 29,\n \"phone_number\": \"+919876543210\",\n \"type\": \"customer\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-24T07:24:34+00:00\",\n \"ring_duration\": 11\n },\n {\n \"leg_index\": 2,\n \"agent\": {\n \"uuid\": \"68baab1d30e05351\",\n \"name\": \"Agent Name\",\n \"email\": \"xyz@email.com\",\n \"contact\": \"+911234567890\",\n \"extension\": \"14\"\n },\n \"dial_status\": \"ANSWER\",\n \"result\": \"answered\",\n \"department\": {\n \"id\": \"68639de95bad6808\",\n \"name\": \"Extension Directory\"\n },\n \"started_at\": \"2026-04-24T07:24:51+00:00\",\n \"ended_at\": \"2026-04-24T07:25:02+00:00\",\n \"talk_duration\": 6,\n \"phone_number\": \"+911234567890\",\n \"type\": \"agent\",\n \"pickup_device\": \"phone\",\n \"answered_at\": \"2026-04-24T07:24:56+00:00\",\n \"ring_duration\": 5\n }\n ],\n \"billable\": true,\n \"comments\": []\n }\n}\n\nThe Disposition Webhook enables clients to perform actions based on the disposition data added to a call.
\nThis webhook is triggered when a disposition is submitted for a call and can be used to:
\nCollect call and disposition data in your datastore
\nTrigger custom integrations (e.g., create/update leads in CRM)
\nThis is a single event (not lifecycle-based)
\nTriggered after a disposition is submitted
\nContains:
\nDisposition data
\nComments (if added)
\nThe payload contains:
\ndispositions array (at least one entry)
comments array (can be empty)
{\n \"company_id\": \"6836cad944e39380\",\n \"event_id\": \"event-disposition-1\",\n \"event_type\": \"disposition\",\n \"event_sequence\": 4001,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-03-24T04:11:13Z\",\n \"channel\": \"call\",\n \"direction\": \"\",\n \"session_id\": \"stage2.1775129350.1761\",\n \"system_identifier\": null,\n \"customer_identifier\": \"+919999999999\",\n \"payload\": {\n \"dispositions\": [\n {\n \"type\": 1,\n \"name\": \"test1\",\n \"user_id\": \"694e6be5a520b309\",\n \"added_at\": \"2026-03-18T05:34:02+00:00\"\n },\n {\n \"type\": 2,\n \"name\": \"Test_101\",\n \"user_id\": \"694e6be5a520b309\",\n \"added_at\": \"2026-03-18T05:34:02+00:00\"\n }\n ],\n \"comments\": [\n {\n \"id\": \"d74a790f0de2162f\",\n \"content\": \"1121212\",\n \"posted_at\": \"2026-03-24T04:11:13+00:00\",\n \"posted_by\": {\n \"uuid\": \"694e6be5a520b309\",\n \"name\": \"John\",\n \"email\": \"\",\n \"extension\": 21,\n \"contact\": \"+919999999999\"\n }\n }\n ]\n }\n}\n\n{ \n\"company_id\": \"6836cad944e39380\", \n\"event_id\": \"event-disposition-2\", \n\"event_type\": \"disposition\", \n\"event_sequence\": 4002, \n\"event_version\": \"1\", \n\"timestamp\": \"2026-03-24T04:11:13Z\", \n\"channel\": \"call\", \n\"direction\": \"\", \n\"session_id\": \"stage2.1775129350.1761\", \n\"system_identifier\": null, \n\"customer_identifier\": \"+919999999999\", \n\"payload\": { \n\"dispositions\": [ \n{ \n\"type\": 1, \n\"name\": \"test1\", \n\"user_id\": \"694e6be5a520b309\", \n\"added_at\": \"2026-03-18T05:34:02+00:00\" \n}, \n{ \n\"type\": 2, \n\"name\": \"Test_101\", \n\"user_id\": \"694e6be5a520b309\", \n\"added_at\": \"2026-03-18T05:34:02+00:00\" \n} \n], \n\"comments\": [] \n} \n}\n\n{\n \"company_id\": \"6836cad944e39380\",\n \"event_id\": \"event-disposition-3\",\n \"event_type\": \"disposition\",\n \"event_sequence\": 4003,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-03-24T04:11:13Z\",\n \"channel\": \"call\",\n \"direction\": \"\",\n \"session_id\": \"stage2.1775129350.1761\",\n \"system_identifier\": null,\n \"customer_identifier\": \"+919999999999\",\n \"payload\": {\n \"dispositions\": [\n {\n \"type\": 1,\n \"name\": \"test1\",\n \"user_id\": \"694e6be5a520b309\",\n \"added_at\": \"2026-03-18T05:34:02+00:00\"\n }\n ],\n \"comments\": []\n }\n}\n\nCall webhooks allow you to track the complete lifecycle of a voice call in real time — from initiation to completion.
\nBy listening to different event_type values, you can reconstruct the full journey of a call and build logic for CRM updates, analytics, or automation workflows.
An Event Lifecycle represents the complete set of events generated during a session.
\nAll events are grouped using a common session_id and channel
For simple or historical events (e.g., disposition), only a single event may be sent
\nFor calls, multiple events together form a full lifecycle
\nBy tracking event_type, you can follow a session from start to finish.
A typical call goes through multiple stages:
\nCall is initiated
\nSystem dials the target (agent/extension)
\nCall is answered
\nCall ends and summary is generated
\ncall.initiated
Call session is created
call.ivr_started
Call reaches IVR (if applicable)
call.dial_begin
System starts dialing a target
call.answered
Call is answered
call.end
Final event after hangup
Includes durations, analytics, and recording details
call.summary
Final comprehensive summary of the entire call session
Contains the complete call log and structured overview
Call transfers are handled using the same event structure (no separate transfer event).
\nEach transfer creates a new call.dial_begin event
The leg_index increments with each transfer
Example:
\nAgent A answers → leg_index = 1
\nCall transferred to Agent B → new dial event with leg_index = 2
\nThis creates a clean, sequential timeline of the call.
\nUse event_type to track call progression
Use event_sequence (from root) to maintain order
Use customer_identifier for CRM mapping
{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745fc0df84a7d230bfae2d1d8f3bd51fd0428d1001150755b15a265219c37f0b0770\",\n \"event_type\": \"message.received\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T10:06:07.835252916Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"incoming\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"1975ec0a-67fe-4a37-af4b-4ed7449862ab\",\n \"message_by\": null,\n \"action\": \"incoming\",\n \"status\": \"received\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Offer\"\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAEhggQUNCREQyRUMxQzIxQ0MyRTI3RDIwNTIxODRGN0MyNjYA\",\n \"myop_ref_id\": null,\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T10:06:07.617308Z\",\n \"modified\": \"2026-04-20T10:06:07.617322Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": null\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:06:07.611982Z\",\n \"last_message_at\": \"2026-04-20T10:06:07.617308Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:06:07.614946Z\",\n \"unread_count\": 1\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745f5145bae5ebfa83eceb4a3103e21f8b309bc2cac8808e1db4a5b20f02ada88fa3\",\n \"event_type\": \"message.sent\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-21T07:35:45.118532415Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"25f8502f-d2e9-48dd-a0e7-e1878f05cdec\",\n \"message_by\": \"69e5f4c1738c9233\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi\",\n \"preview_url\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSMzYxODA3ODhCOEI4QjA2RkNDAA==\",\n \"myop_ref_id\": \"12cd282a-6a50-54f5-803b-4fd1d9aaee24\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-21T07:35:37.005192Z\",\n \"modified\": \"2026-04-21T07:35:44.899819Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-21T07:35:40.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-22T06:52:26.175158Z\",\n \"last_message_at\": \"2026-04-21T07:35:37.005192Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-21T07:35:37.003554Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745fcc977ccf288a3c8ff32a34fc78b423551f9888e92fe8d1a6d14c7f9a4b253f97\",\n \"event_type\": \"message.sent\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T11:04:09.508726955Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"43157b87-eaef-4e0b-ae29-dc88995bf340\",\n \"message_by\": \"69e5f4c1738c9233\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"838900f1-2566-4607-a592-8beebbde9031\",\n \"name\": \"demo\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hi \\n \\n\\nclothes \\n10% discount on all fancy dresses\\n\\nelectronics\\n20% discount on all laptops\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offers 1\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offer 2\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\",\n \"meta_media_id\": \"2996771587176712\"\n }\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\",\n \"meta_media_id\": \"4105390803094430\"\n }\n }\n }\n ]\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSRUExNDc5MDk3QUFEMjQxMjRDAA==\",\n \"myop_ref_id\": \"\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T11:04:00.899104Z\",\n \"modified\": \"2026-04-20T11:04:09.113057Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T11:04:04.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"last_message_at\": \"2026-04-20T11:04:00.899104Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:46:56.886618Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"cmp\"\n }\n}\n\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745fbe3e84d7461caac14eb826b7e132de1326e8d4a758c32bb275e485ad3003416d\",\n \"event_type\": \"message.sent\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T10:47:05.840866582Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"9736d20a-244b-4c9d-a638-dd6f3cc748bc\",\n \"message_by\": \"69ddcadb47289979\",\n \"action\": \"outgoing\",\n \"status\": \"sent\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"838900f1-2566-4607-a592-8beebbde9031\",\n \"name\": \"demo\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hi \\n \\n\\nclothes \\n10% discount on all fancy dresses\\n\\nelectronics\\n20% discount on all laptops\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offers 1\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offer 2\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"header\": {},\n \"body\": {}\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSMUFFNjhBRkZCMjFCODY4MURBAA==\",\n \"myop_ref_id\": null,\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T10:46:56.888495Z\",\n \"modified\": \"2026-04-20T10:47:05.686486Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T10:47:02.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"last_message_at\": \"2026-04-20T10:46:56.888495Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:46:56.886618Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"api\"\n }\n}\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745ff72844c20d831381c56eb70f4d9cd98a8d818744f4dc4efa3fdc41c178ca2ea0\",\n \"event_type\": \"message.read\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-21T07:38:12.733455281Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"25f8502f-d2e9-48dd-a0e7-e1878f05cdec\",\n \"message_by\": \"69e5f4c1738c9233\",\n \"action\": \"outgoing\",\n \"status\": \"read\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi\",\n \"preview_url\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSMzYxODA3ODhCOEI4QjA2RkNDAA==\",\n \"myop_ref_id\": \"12cd282a-6a50-54f5-803b-4fd1d9aaee24\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-21T07:35:37.005192Z\",\n \"modified\": \"2026-04-21T07:38:12.546720Z\",\n \"is_read\": true,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-21T07:35:40.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-21T07:35:41.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": \"2026-04-21T07:38:10.000000Z\"\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-22T06:52:26.175158Z\",\n \"last_message_at\": \"2026-04-21T07:35:37.005192Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-21T07:35:37.003554Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745f23b7815c33fe0075d83976c9d6b00e5a3ad99c89a9aa0eac0b4b4501e9f0d746\",\n \"event_type\": \"message.read\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T11:04:41.396289322Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"43157b87-eaef-4e0b-ae29-dc88995bf340\",\n \"message_by\": \"69e5f4c1738c9233\",\n \"action\": \"outgoing\",\n \"status\": \"read\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"838900f1-2566-4607-a592-8beebbde9031\",\n \"name\": \"demo\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hi \\n \\n\\nclothes \\n10% discount on all fancy dresses\\n\\nelectronics\\n20% discount on all laptops\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offers 1\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offer 2\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\",\n \"meta_media_id\": \"2996771587176712\"\n }\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\",\n \"meta_media_id\": \"4105390803094430\"\n }\n }\n }\n ]\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSRUExNDc5MDk3QUFEMjQxMjRDAA==\",\n \"myop_ref_id\": \"\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T11:04:00.899104Z\",\n \"modified\": \"2026-04-20T11:04:41.226943Z\",\n \"is_read\": true,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T11:04:04.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-20T11:04:04.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": \"2026-04-20T11:04:38.000000Z\"\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"last_message_at\": \"2026-04-20T11:04:00.899104Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:46:56.886618Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"cmp\"\n }\n}\n {\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745fa22890f3c50e4d494dd9fe7aa7bd5c8751f316266cbe4b41adc95f12949f31bf\",\n \"event_type\": \"message.read\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T10:49:29.069140263Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"9736d20a-244b-4c9d-a638-dd6f3cc748bc\",\n \"message_by\": \"69ddcadb47289979\",\n \"action\": \"outgoing\",\n \"status\": \"read\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"838900f1-2566-4607-a592-8beebbde9031\",\n \"name\": \"demo\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hi \\n \\n\\nclothes \\n10% discount on all fancy dresses\\n\\nelectronics\\n20% discount on all laptops\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offers 1\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offer 2\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"header\": {},\n \"body\": {}\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSMUFFNjhBRkZCMjFCODY4MURBAA==\",\n \"myop_ref_id\": null,\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T10:46:56.888495Z\",\n \"modified\": \"2026-04-20T10:49:28.921198Z\",\n \"is_read\": true,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T10:47:02.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-20T10:47:02.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": \"2026-04-20T10:49:27.000000Z\"\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"last_message_at\": \"2026-04-20T10:46:56.888495Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:46:56.886618Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"api\"\n }\n }\n\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745f6775ae9a9c3f31c1856f418a3ba5cc8384d921640318cd4306eda9ec13460675\",\n \"event_type\": \"message.delivered\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-21T07:35:55.079101173Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"25f8502f-d2e9-48dd-a0e7-e1878f05cdec\",\n \"message_by\": \"69e5f4c1738c9233\",\n \"action\": \"outgoing\",\n \"status\": \"delivered\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"text\",\n \"context\": {\n \"body\": \"Hi\",\n \"preview_url\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSMzYxODA3ODhCOEI4QjA2RkNDAA==\",\n \"myop_ref_id\": \"12cd282a-6a50-54f5-803b-4fd1d9aaee24\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-21T07:35:37.005192Z\",\n \"modified\": \"2026-04-21T07:35:54.951262Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-21T07:35:40.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-21T07:35:41.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-22T06:52:26.175158Z\",\n \"last_message_at\": \"2026-04-21T07:35:37.005192Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-21T07:35:37.003554Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n\n {\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745f0333273db805d22cddb09100cda5ac81b48959104847b679ef2cc2d6f97b49a1\",\n \"event_type\": \"message.delivered\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T11:04:14.865381064Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"43157b87-eaef-4e0b-ae29-dc88995bf340\",\n \"message_by\": \"69e5f4c1738c9233\",\n \"action\": \"outgoing\",\n \"status\": \"delivered\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"838900f1-2566-4607-a592-8beebbde9031\",\n \"name\": \"demo\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hi \\n \\n\\nclothes \\n10% discount on all fancy dresses\\n\\nelectronics\\n20% discount on all laptops\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offers 1\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offer 2\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\",\n \"meta_media_id\": \"2996771587176712\"\n }\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\",\n \"meta_media_id\": \"4105390803094430\"\n }\n }\n }\n ]\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSRUExNDc5MDk3QUFEMjQxMjRDAA==\",\n \"myop_ref_id\": \"\",\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T11:04:00.899104Z\",\n \"modified\": \"2026-04-20T11:04:14.768538Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T11:04:04.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-20T11:04:04.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"last_message_at\": \"2026-04-20T11:04:00.899104Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:46:56.886618Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"cmp\"\n }\n }\n\n {\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745fa20f32ff153999206d444df68ea25225f8502647bf4e9cdd3edc84d17120f4de\",\n \"event_type\": \"message.delivered\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T10:47:14.764970775Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"1196177000238423\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"9736d20a-244b-4c9d-a638-dd6f3cc748bc\",\n \"message_by\": \"69ddcadb47289979\",\n \"action\": \"outgoing\",\n \"status\": \"delivered\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"838900f1-2566-4607-a592-8beebbde9031\",\n \"name\": \"demo\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hi \\n \\n\\nclothes \\n10% discount on all fancy dresses\\n\\nelectronics\\n20% discount on all laptops\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"7c5fe81d-a461-4b4f-8aa2-02d2b9e9dacc\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offers 1\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"335ad6a5-618b-4aa9-a956-72c87f39744e\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"offer 2\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Visit our website\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.goggle.com\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"header\": {},\n \"body\": {}\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSMUFFNjhBRkZCMjFCODY4MURBAA==\",\n \"myop_ref_id\": null,\n \"errors\": null\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T10:46:56.888495Z\",\n \"modified\": \"2026-04-20T10:47:14.635122Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T10:47:02.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-20T10:47:02.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"last_message_at\": \"2026-04-20T10:46:56.888495Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:46:56.886618Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1196177000238423\",\n \"mode\": \"lc\",\n \"source\": \"api\"\n }\n }\n\n{\n \"company_id\": \"68afe231d6fbf630\",\n \"event_id\": \"event-6576745fcc7c838249097362f5667b13589db76f51aeb40e91aa5ed8e11d73ed05d66e24\",\n \"event_type\": \"message.failed\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T07:06:06.374005231Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"f55832ac-0034-45d9-aa13-b0adf2e5ac18\",\n \"system_identifier\": \"1093935693797638\",\n \"customer_identifier\": \"919990094254\",\n \"payload\": {\n \"id\": \"7b5ebf3f-806e-4026-9e80-30d53166573b\",\n \"message_by\": \"68afe231d8447863\",\n \"action\": \"outgoing\",\n \"status\": \"failed\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"50907dc3-4e71-4cb2-8c89-3b02d3c89e54\",\n \"name\": \"greeting\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Dear Mayank,\\n\\nWelcome to Bob Private Limited, your onestop solution for all interior designing requirements.\\n\\nThanks,\\nBob LTD\"\n },\n \"template_payload\": {\n \"header\": {},\n \"body\": {\n \"name\": \"Mayank\"\n }\n },\n \"link_tracking\": false\n }\n },\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE5OTkwMDk0MjU0FQIAERgSOEYzQkVBNjk4NkNDMDVFODc2AA==\",\n \"myop_ref_id\": \"a6b2e8be-2def-580e-a089-f1c5b0092b7c\",\n \"errors\": {\n \"130472\": \"Failed to send message because this user's phone number is part of an experiment\"\n }\n },\n \"star_mark\": false,\n \"created\": \"2026-04-20T07:05:49.051116Z\",\n \"modified\": \"2026-04-20T07:06:06.204376Z\",\n \"is_read\": false,\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": null\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": null\n },\n {\n \"name\": \"read\",\n \"timestamp\": null\n }\n ],\n \"conversation\": {\n \"id\": \"f55832ac-0034-45d9-aa13-b0adf2e5ac18\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"9990094254\",\n \"customer_name\": \"919990094254\",\n \"assigned_to\": \"68afe231d8447863\",\n \"status\": \"assigned\",\n \"expire_at\": null,\n \"last_message_at\": \"2026-04-20T07:05:49.051116Z\",\n \"created\": \"2026-04-20T07:05:49.048491Z\",\n \"modified\": \"2026-04-20T07:05:49.048502Z\",\n \"unread_count\": 0\n },\n \"activity\": null,\n \"phone_number_id\": \"1093935693797638\",\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n{\n \"company_id\": \"68afe231d6fbf630\",\n \"event_id\": \"event-6576745ff2c16c6579412091c83b6de2b8fada5a937344f403aebce289a473f9c940636c\",\n \"event_type\": \"message.link_tracking\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T07:22:11.640105055Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"outgoing\",\n \"session_id\": \"7ee8fc4a-31c8-4563-b2ad-66a8835f3088\",\n \"system_identifier\": \"1093935693797638\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"conversation\": {\n \"id\": \"7ee8fc4a-31c8-4563-b2ad-66a8835f3088\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"68afe231d8447863\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T05:17:21.308869Z\",\n \"last_message_at\": \"2026-04-20T07:21:00.847325Z\",\n \"created\": \"2026-04-07T12:31:53.041754Z\",\n \"modified\": \"2026-04-20T06:39:19.467586Z\",\n \"unread_count\": 0\n },\n \"link_tracking\": {\n \"template_id\": \"795dae53-7322-4f74-9a71-6814a926e1a2\",\n \"template_name\": \"carousel\",\n \"button_info\": \"card-0-btn-0\",\n \"clicked_at\": \"2026-04-20T07:22:11.540441Z\"\n },\n \"activity\": null,\n \"id\": \"1732d208-e130-4568-a1e2-96052f7e5922\",\n \"source\": \"cmp\",\n \"action\": \"outgoing\",\n \"data\": {\n \"type\": \"template\",\n \"context\": {\n \"template_id\": \"795dae53-7322-4f74-9a71-6814a926e1a2\",\n \"name\": \"carousel\",\n \"language\": \"en\",\n \"category\": \"marketing\",\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Hello Suraj Singh,\\n\\nDiscover products from BOB LTD.\\n\\nThank You\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"add749b2-2927-4733-bec8-742193bad282\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Discover more.\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"BOB LTD\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://new-portfolio-2026-8dyx.vercel.app/\"\n }\n ]\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"format\": \"image\",\n \"media_id\": \"6b75565e-90d6-40ec-ad58-1dc16690931d\"\n },\n \"body\": {\n \"type\": \"text\",\n \"context\": \"Designer\"\n },\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"Google\",\n \"index\": 0,\n \"format\": \"STATIC\",\n \"url\": \"https://www.google.com/\"\n }\n ]\n }\n }\n ],\n \"template_payload\": {\n \"body\": {\n \"name\": \"Suraj Singh\"\n },\n \"carousel\": [\n {\n \"index\": 0,\n \"components\": {\n \"header\": {\n \"media_id\": \"add749b2-2927-4733-bec8-742193bad282\",\n \"meta_media_id\": \"1483016140130432\"\n }\n }\n },\n {\n \"index\": 1,\n \"components\": {\n \"header\": {\n \"media_id\": \"6b75565e-90d6-40ec-ad58-1dc16690931d\",\n \"meta_media_id\": \"937893199208712\"\n }\n }\n }\n ]\n },\n \"link_tracking\": true\n }\n },\n \"status\": \"read\",\n \"is_read\": true,\n \"message_by\": \"68afe231d8447863\",\n \"is_reply\": false,\n \"reply_to\": null,\n \"reply_data\": null,\n \"metadata\": {\n \"waba_msg_id\": \"wamid.HBgMOTE3Nzc5ODEyOTU1FQIAERgSRjUwMDExRDE4RkNBMTcyMTY0AA==\",\n \"myop_ref_id\": \"\"\n },\n \"events\": [\n {\n \"name\": \"sent\",\n \"timestamp\": \"2026-04-20T07:21:10.000000Z\"\n },\n {\n \"name\": \"delivered\",\n \"timestamp\": \"2026-04-20T07:21:11.000000Z\"\n },\n {\n \"name\": \"read\",\n \"timestamp\": \"2026-04-20T07:22:03.000000Z\"\n }\n ],\n \"created\": \"2026-04-20T07:21:00.847325Z\",\n \"modified\": \"2026-04-20T07:22:05.091019Z\",\n \"errors\": null,\n \"conversation_id\": \"7ee8fc4a-31c8-4563-b2ad-66a8835f3088\",\n \"phone_number_id\": \"1093935693797638\",\n \"mode\": \"lc\"\n }\n}\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745fea1a770cca8877b9d9b85dc4883508725a37f3f439fb334b051d213764eac554\",\n \"event_type\": \"conversation.assign\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T10:39:30.33889691Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"69e5f4c1738c9233\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"assigned\",\n \"expire_at\": \"2026-04-21T10:38:17.645540Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:39:30.235181Z\",\n \"activity\": {\n \"id\": \"892d4eee-ee79-4da6-9dca-d7abdfebb4f2\",\n \"conversation_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"activity\": \"conv_assigned\",\n \"action_by\": \"69e5f4c1738c9233\",\n \"action_to\": \"69e5f4c1738c9233\",\n \"created\": \"2026-04-20T10:39:30.239055Z\"\n },\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n{\n \"company_id\": \"69ddcadb46536124\",\n \"event_id\": \"event-6576745f6e0d9098e16d4b5e4a2c9a614339f8e82cebd07c2e0cf8db4d12025e1d130d60\",\n \"event_type\": \"conversation.close\",\n \"event_sequence\": 1,\n \"event_version\": \"1\",\n \"timestamp\": \"2026-04-20T10:20:29.554290169Z\",\n \"channel\": \"whatsapp\",\n \"direction\": \"\",\n \"session_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"system_identifier\": \"69e5f4c1738c9233\",\n \"customer_identifier\": \"917779812955\",\n \"payload\": {\n \"id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"customer_country_code\": \"91\",\n \"customer_contact\": \"7779812955\",\n \"customer_name\": \"Suraj Singh\",\n \"assigned_to\": \"69e5f4c1738c9233\",\n \"status\": \"closed\",\n \"expire_at\": \"2026-04-21T10:20:00.563707Z\",\n \"created\": \"2026-04-20T09:57:39.458608Z\",\n \"modified\": \"2026-04-20T10:20:29.439071Z\",\n \"activity\": {\n \"id\": \"eb8f82d8-396a-4ea0-a42a-8f6c3931e913\",\n \"conversation_id\": \"e8e99f13-f41e-4655-b393-09e03cb5f91c\",\n \"activity\": \"conv_closed\",\n \"action_by\": \"69e5f4c1738c9233\",\n \"action_to\": null,\n \"created\": \"2026-04-20T10:20:29.441242Z\"\n },\n \"mode\": \"lc\",\n \"source\": \"lc\"\n }\n}\n\nMyOperator sends the following payloads for message events:
\nmessage.sent: Triggered when any message or template is sent via Live Chat, Campaign, or API.
\nmessage.received: Triggered when any message is received.
\nmessage.delivered: Triggered when a message or template is delivered to the customer.
\nmessage.read: Triggered when the customer reads a message or template.
\nmessage.failed: Triggered when a message or template fails to send.
\nmessage.link_tracking: Triggered when the template Track URL is clicked.
\nconversation.assign: Triggered when a conversation is assigned
\nconversation.close: Triggered when a conversation is closed.
\nWebhooks are HTTP callbacks that receive event notifications. MyOperator uses webhooks to notify your application whenever a call or message event occurs in your account.
\nWhether you are building a CRM integration, analytics pipeline, or internal dashboard, webhooks provide real-time, event-driven updates for all communication activities.
\nFor example, if your agent has received a call:
\nYou will receive a webhook during the call (in-call webhook)
\nAfter the call has finished (after-call webhook)
\nAfter any disposition has been submitted (disposition webhook)
\nSimilarly, MyOperator sends the following payloads for message events:
\nMessage Sent: Triggered when any message or template is sent via Live Chat, Campaign, or API
\nMessage Delivered: Triggered when a message or template is delivered to the customer
\nMessage Read: Triggered when the customer reads a message or template
\nMessage Failed: Triggered when a message or template fails to send
\nAll webhook payloads follow a flattened envelope structure.
\nThe root level (envelope) contains static metadata used for routing and identification
\nThe payload object contains event-specific data
\nThis design ensures faster processing and avoids deeply nested JSON structures.
\nWebhooks are delivered using the HTTP POST method.
\nWhenever a configured event occurs (such as call events or message events), MyOperator sends an HTTP POST request to your configured Target URL. The request body contains the event payload.
\nThe webhook event payload format depends on the Content-Type header configured for the webhook.
\napplication/json
\napplication/x-www-form-urlencoded
\nmultipart/form-data
\napplication/json
The complete event payload is sent as a JSON body
application/x-www-form-urlencoded
The payload is sent as key-value pairs (nested objects are serialised appropriately)
multipart/form-data
The payload is sent as multipart form fields
If no Content-Type is configured, the default is application/json.
\nYour webhook endpoint should:
\nAccept HTTP POST requests
\nParse the request body based on Content-Type
\nReturn a 2xx status code to acknowledge successful receipt
\nTo ensure reliable webhook processing, follow these guidelines:
\nRespond Quickly
Always return HTTP 200 OK immediately after receiving the webhook.
If processing is heavy, queue the event and process it asynchronously.
Idempotency (event_id)
Webhook retries may occur due to network issues.
Use event_id to detect duplicates and avoid reprocessing the same event.
Event Ordering (event_sequence)
Events may arrive out of order.
Use event_sequence to process events in the correct chronological order.
Phone Number Format (E.164)
All phone numbers (system_identifier, customer_identifier) follow E.164 format.
Example: +919876543210
\nUse this format for consistent lookups in your system.
\nHeaders are configured as key-value pairs in the panel. These headers are included in every webhook request.
\nAuthentication
\nPassing secret tokens
\nIdentifying the request source
\nCustom validation logic
\nKey: X-Webhook-Token Value: your-secret-token
Multiple headers can be added
\nHeaders are included in all webhook requests
\nFollow standard HTTP header naming conventions
\nYou can configure authentication for webhook delivery.
\nNo Auth
No authentication headers are added.
Basic Auth
Uses HTTP Basic Authentication.
{ \"username\": \"admin\", \"password\": \"123456\" }API Key Auth
Sends API key as a header.
Key: X-API-Key Value: your-api-keyAuthentication applies to all webhook requests once configured
\nAuthentication overrides conflicting headers (e.g., Authorisation)
\nCustom headers are still included unless they conflict with auth headers
\nThe Get User API allows you to retrieve user details from your MyOperator account. This API supports fetching users using pagination and keyword-based search, enabling efficient retrieval of specific user records.
\nThe API supports pagination to retrieve large volumes of users efficiently.
\nThe API returns user details along with pagination information.
\n{ \n\"status\": \"success\", \n\"page_size\": 20, \n\"total_user\": 1, \n\"data\": \\[ \n{ \n\"user_id\": \"666666666666\", \n\"uuid\": \"777777777777\", \n\"company_id\": \"61eaa7ed83906838\", \n\"name\": \"Anonymous User\", \n\"email\": null, \n\"extension\": \"0\", \n\"contact_number\": \"67\", \n\"contact_type\": null, \n\"alternate_number\": null, \n\"alternate_contact_type\": null, \n\"role_id\": \"8\", \n\"is_active\": \"1\", \n\"is_enabled\": \"1\", \n\"is_available\": 0 \n} \n\\], \n\"next_page\": \"\", \n\"prev_page\": \"\", \n\"code\": 200 \n}\n\nA valid Public API token must be included in every request
\nUse keyword to search users by name, email, or phone number
Use pagination parameters to retrieve large datasets
\nSet _all = 1 to fetch all users in a single request
Types of user roles:
\n1 - SuperAdmin
\n2 - Admin
\n4 - Manager
\n8 - Basic
\nUnique MyOperator API token issued to the user who is accessing API.
\n","type":"text/plain"},"key":"token","value":""},{"description":{"content":"Words you want to search for (accepts: Name, Email, Phone number).
\n","type":"text/plain"},"key":"keyword","value":""},{"description":{"content":"Number of pages (defaults to 1)
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Results per page (defaults to 20, maximum 100).
\n","type":"text/plain"},"key":"page-size","value":null},{"description":{"content":"Set this parameter to 1 if you require the list of all Users.
\n","type":"text/plain"},"key":"_all","value":null}],"variable":[]}},"response":[{"id":"f1e5382e-8cff-4a90-b9a7-d4a91eb0d431","name":"Get Users","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://developers.myoperator.co/search/user?token=&keyword=&page=&page-size&_all","protocol":"https","host":["developers","myoperator","co"],"path":["search","user"],"query":[{"key":"token","value":""},{"key":"keyword","value":""},{"key":"page","value":""},{"key":"page-size","value":null},{"key":"_all","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"page_size\": 20,\n \"total_user\": 1,\n \"data\": [\n {\n \"user_id\": \"666666666666\",\n \"uuid\": \"777777777777\",\n \"company_id\": \"61eaa7ed83906838\",\n \"name\": \"Anonymous User\",\n \"email\": null,\n \"extension\": \"0\",\n \"contact_number\": \"67\",\n \"contact_type\": null,\n \"alternate_number\": null,\n \"alternate_contact_type\": null,\n \"role_id\": \"8\",\n \"is_active\": \"1\",\n \"is_enabled\": \"1\",\n \"is_available\": 0\n }\n ],\n \"next_page\": \"\",\n \"prev_page\": \"\",\n \"code\": 200\n}"}],"_postman_id":"31959eef-963d-4216-84a4-64c9e4677ff7"},{"name":"Create User","id":"e94d0c64-5dc8-497b-9ed0-ecd7d932a50e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://developers.myoperator.co/search/user?token&name&contact_number&country_code&extension&email&alternate_contact_number&alternate_cc&panel_access&receive_calls&contact_type","description":"The Add User API allows you to create a new user in your MyOperator account. This API is used to add users with required details such as contact information, extension, and access configuration.
\nUser creation depends on permissions defined by the role
\nSuperAdmin (id = 1) and Admin (id = 2) can add users by default
\nExtension must be a unique integer value
\nContact number must be unique within the company
\nContact number can be used as an alternate number for another user (verification will be triggered)
\nalternate_cc is required only if alternate_contact_number is provided
Unique MyOperator API token issued to the user who is accessing API.
\n","type":"text/plain"},"key":"token","value":null},{"description":{"content":"User's name.
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Primary contact number of the user (without leading country code).
\n","type":"text/plain"},"key":"contact_number","value":null},{"description":{"content":"Country code of the primary contact number of the User(do not mistake it for state code)
\n","type":"text/plain"},"key":"country_code","value":null},{"description":{"content":"Extension number for the user (usually between 11 to 99, should be a number not assigned as an extension to another User).
\n","type":"text/plain"},"key":"extension","value":null},{"description":{"content":"Email of the user.
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"Alternate contact number of the user if available (without leading country code).
\n","type":"text/plain"},"key":"alternate_contact_number","value":null},{"description":{"content":"Country code for alternate number (required only if alternate contact number exists).
\n","type":"text/plain"},"key":"alternate_cc","value":null},{"description":{"content":"1: User will be able to access MyOperator panel and view his/her logs.\n2: User will not be able to login. (defaults to 1)
\n","type":"text/plain"},"key":"panel_access","value":null},{"description":{"content":"1: User will receive IVR calls on contact_number.\n2: User will not receive any calls. (defaults to 1)
\n","type":"text/plain"},"key":"receive_calls","value":null},{"description":{"content":"Mobile / SIP / Landline. (defaults to mobile)
\n","type":"text/plain"},"key":"contact_type","value":null}],"variable":[]}},"response":[{"id":"20384ad4-f8f0-4ae7-821a-a9b4f5140488","name":"Create User","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://developers.myoperator.co/search/user?token&name&contact_number&country_code&extension&email&alternate_contact_number&alternate_cc&panel_access&receive_calls&contact_type","protocol":"https","host":["developers","myoperator","co"],"path":["search","user"],"query":[{"key":"token","value":null,"description":"Unique MyOperator API token issued to the user who is accessing API."},{"key":"name","value":null,"description":"User's name."},{"key":"contact_number","value":null,"description":"Primary contact number of the user (without leading country code)."},{"key":"country_code","value":null,"description":"Country code of the primary contact number of the User(do not mistake it for state code)"},{"key":"extension","value":null,"description":"Extension number for the user (usually between 11 to 99, should be a number not assigned as an extension to another User)."},{"key":"email","value":null,"description":"Email of the user."},{"key":"alternate_contact_number","value":null,"description":"Alternate contact number of the user if available (without leading country code)."},{"key":"alternate_cc","value":null,"description":"Country code for alternate number (required only if alternate contact number exists)."},{"key":"panel_access","value":null,"description":"1: User will be able to access MyOperator panel and view his/her logs.\n2: User will not be able to login. (defaults to 1)"},{"key":"receive_calls","value":null,"description":"1: User will receive IVR calls on contact_number.\n2: User will not receive any calls. (defaults to 1)"},{"key":"contact_type","value":null,"description":"Mobile / SIP / Landline. (defaults to mobile)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"message\": \"user added successfully\",\n \"uuid\": \"69ce5a7f8d26d639\"\n}"}],"_postman_id":"e94d0c64-5dc8-497b-9ed0-ecd7d932a50e"},{"name":"Update User","id":"72867267-2763-472a-8ad7-e59dfd636d0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://developers.myoperator.co/search/user?token&name&contact_number&country_code&extension&email&alternate_contact_number&alternate_cc&panel_access&receive_calls&contact_type","description":"The Update User API allows you to update details of an existing user in your MyOperator account. This API can be used to modify user information such as contact details, extension, and access configuration.
\nA valid API token must be included in every request
\nuuid is required to identify the user to be updated
Only the fields provided in the request will be updated
\nalternate_cc is required only if alternate_contact_number is provided
Unique MyOperator API token issued to the user who is accessing API.
\n","type":"text/plain"},"key":"token","value":null},{"description":{"content":"User's name.
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Primary contact number of the user (without leading country code).
\n","type":"text/plain"},"key":"contact_number","value":null},{"description":{"content":"Country code of the primary contact number of the User(do not mistake it for state code)
\n","type":"text/plain"},"key":"country_code","value":null},{"description":{"content":"Extension number for the user (usually between 11 to 99, should be a number not assigned as an extension to another User).
\n","type":"text/plain"},"key":"extension","value":null},{"description":{"content":"Email of the user.
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"Alternate contact number of the user if available (without leading country code).
\n","type":"text/plain"},"key":"alternate_contact_number","value":null},{"description":{"content":"Country code for alternate number (required only if alternate contact number exists).
\n","type":"text/plain"},"key":"alternate_cc","value":null},{"description":{"content":"1: User will be able to access MyOperator panel and view his/her logs.\n2: User will not be able to login. (defaults to 1)
\n","type":"text/plain"},"key":"panel_access","value":null},{"description":{"content":"1: User will receive IVR calls on contact_number.\n2: User will not receive any calls. (defaults to 1)
\n","type":"text/plain"},"key":"receive_calls","value":null},{"description":{"content":"Mobile / SIP / Landline. (defaults to mobile)
\n","type":"text/plain"},"key":"contact_type","value":null}],"variable":[]}},"response":[],"_postman_id":"72867267-2763-472a-8ad7-e59dfd636d0b"}],"id":"a31d7c20-2d2e-4048-ac82-74a5a5827fb2","description":"This documentation helps you implement the RESTful MyOperator APIs for managing users.
The APIs return responses in JSON format and are stateless, meaning each request must be authenticated using an API token.
User APIs allow developers to create, retrieve, and update users within a MyOperator account. These APIs can be used to manage user information, automate onboarding, and integrate user data with external systems such as CRMs and internal tools.
\nTo obtain your API token:
\nAll API responses are returned in JSON format and include a status field.
\nWhen status = success, the response contains:
code
data (for GET and POST requests)
For PUT requests, the response may contain a success message instead of a data object.
\nWhen status = error, the response contains:
code
message
Retrieve user details from the MyOperator account.
\nCreate a new user in the MyOperator account.
\nUpdate existing user details.
\n","_postman_id":"a31d7c20-2d2e-4048-ac82-74a5a5827fb2"},{"name":"Call Apis","item":[{"name":"Search Logs","id":"c9bfdf0c-5080-4bec-8526-37d49fc2906c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://developers.myoperator.co/search/search?token&from&to&log_from&page_size&search_key&filters","description":"The Search Logs API allows you to retrieve call activity logs from your MyOperator account using flexible search and filtering options.
\nThis API supports querying logs using date ranges, keyword search, pagination, and filters, enabling developers to retrieve specific call records efficiently.
\nFilters allow advanced querying of logs and are constructed using filter identifiers retrieved from the Log Filters API.
\nTo use filters in the Search Logs API, follow the steps below:
\nCall the Log Filters API to retrieve the list of available filters.
\nEach filter returned by this API includes a filter ID that corresponds to a specific log attribute.
\nThese filter IDs can be used to construct filter queries for the Search Logs API.
\nUsing the filter IDs retrieved in Step 1, construct filter conditions by combining them with logical operators.
\nSupported logical operators include:
\nAND
OR
Parentheses can be used to define logical grouping.
\nPass the constructed filter expression in the filters parameter of the Search Logs API request.
Example filter expression:
\n12 AND (5 OR 8)
In this example:
\n12, 5, and 8 are filter IDs retrieved from the Log Filters API
AND and OR define how the conditions are combined
The API supports pagination to retrieve large volumes of logs efficiently.
\nUse the value returned in the previous response to fetch the next set of logs.
\nA valid Public API token must be included in every request.
\nThe Log Filters API must be called first to obtain filter IDs.
\nFilters can be combined using logical operators such as AND and OR.
\nPagination parameters should be used when retrieving large datasets.
\nUnique MyOperator API token issued to the user who is accessing API
\n","type":"text/plain"},"key":"token","value":null},{"description":{"content":"Date from when you would like to access logs. Date should be in UTC format(unix timestamp).
\n","type":"text/plain"},"key":"from","value":null},{"description":{"content":"Date upto when you would like to access logs. Date should be in UTC format(unix timestamp).
\n","type":"text/plain"},"key":"to","value":null},{"description":{"content":"From which the logs need to be fetched, defaults to 0 (used for pagination)
\n","type":"text/plain"},"key":"log_from","value":null},{"description":{"content":"Number of logs you want to access(defaults to 20). Max request limit is 100.
\n","type":"text/plain"},"key":"page_size","value":null},{"description":{"content":"Words you want to search for (accepts: Name, Email, Phone number, Comments, Unique id, Caller name)
\n","type":"text/plain"},"key":"search_key","value":null},{"description":{"content":"Filter IDs (from filters API) related with logical operators (AND, OR)
\n","type":"text/plain"},"key":"filters","value":null}],"variable":[]}},"response":[],"_postman_id":"c9bfdf0c-5080-4bec-8526-37d49fc2906c"},{"name":"Log Filters List","id":"6078a2b1-8acf-4ec2-addc-a4ae25671626","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://developers.myoperator.co/search/filters?token","description":"The Log Filters API allows you to retrieve a list of available filters that can be used to refine and customise queries in the Search Logs API. Each filter represents a specific attribute of call logs (such as call type, status, source, etc.) and is associated with a unique filter ID. These filter IDs are required to construct logical filter expressions when querying logs using the Search Logs API.
\nThe Log Filters API is used to discover all available filters supported by the system, retrieve the filter IDs required to build filter expressions, and understand the possible filtering options for call log queries.
\nCall the Log Filters API
\nRetrieve the list of filters along with their corresponding IDs
\nUse these IDs to construct logical expressions
\nPass the constructed expression in the filters parameter of the Search Logs API
\nThe API returns a flat list of filters. Each filter contains:
\nid → Unique identifier for the filter
name → Human-readable name of the filter
parent_id → Indicates hierarchy (0 = parent filter, non-zero = child filter)
Parent-child relationships help group filters logically.
\n{\n \"status\": \"success\",\n \"code\": 200,\n \"filters\": [\n {\n \"id\": \"1\",\n \"name\": \"Source of logs\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Myoperator IVR\",\n \"parent_id\": \"1\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Mobile\",\n \"parent_id\": \"1\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Event of logs\",\n \"parent_id\": \"0\"\n }\n ]\n}\n\nFilters with parent_id = 0 are root categories
Filters with non-zero parent_id are child filters under a category
Example:
\nSource of logs (id: 1) is a parent filter
Myoperator IVR (id: 2)
Mobile (id: 3)
Each filter has a unique id which is used to build logical expressions, i.e., ' 2 OR 3`
2 and 3 are filter IDs under the same parent
OR is used to match any condition
You can also combine filters across categories, i.e:- 2 AND 4
The Log Filters API must be called before using filters in the Search Logs API
\nFilter IDs are dynamic and may change based on account configuration
\nAlways fetch the latest filters before constructing queries
\nSupported logical operators: AND, OR
Parentheses can be used for grouping conditions
\nUnique MyOperator API token issued to the user who is accessing API.
\n","type":"text/plain"},"key":"token","value":null}],"variable":[]}},"response":[{"id":"979f2d1a-670e-4c11-b7ee-bb1331f9c12d","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://developers.myoperator.co/search/filters?token","protocol":"https","host":["developers","myoperator","co"],"path":["search","filters"],"query":[{"key":"token","value":null,"description":"Unique MyOperator API token issued to the user who is accessing API."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"filters\": [\n {\n \"id\": \"1\",\n \"name\": \"Source of logs\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Myoperator IVR\",\n \"parent_id\": \"1\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Mobile\",\n \"parent_id\": \"1\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Event of logs\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"5\",\n \"name\": \"Incoming\",\n \"parent_id\": \"4\"\n },\n {\n \"id\": \"6\",\n \"name\": \"Outgoing\",\n \"parent_id\": \"4\"\n },\n {\n \"id\": \"7\",\n \"name\": \" Type of logs \",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"8\",\n \"name\": \"Call\",\n \"parent_id\": \"7\"\n },\n {\n \"id\": \"9\",\n \"name\": \"SMS\",\n \"parent_id\": \"7\"\n },\n {\n \"id\": \"11\",\n \"name\": \"Status of logs\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"12\",\n \"name\": \"Connected\",\n \"parent_id\": \"11\"\n },\n {\n \"id\": \"13\",\n \"name\": \"Missed\",\n \"parent_id\": \"11\"\n },\n {\n \"id\": \"14\",\n \"name\": \"Voicemail\",\n \"parent_id\": \"11\"\n },\n {\n \"id\": \"15\",\n \"name\": \"Tags\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"21\",\n \"name\": \"Call property\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"22\",\n \"name\": \"Noted\",\n \"parent_id\": \"21\"\n },\n {\n \"id\": \"23\",\n \"name\": \"Archived\",\n \"parent_id\": \"21\"\n },\n {\n \"id\": \"24\",\n \"name\": \"Star Marked\",\n \"parent_id\": \"21\"\n },\n {\n \"id\": \"25\",\n \"name\": \"Two word filters\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"26\",\n \"name\": \"Incoming Myoperator IVR\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"27\",\n \"name\": \"Incoming Mobile\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"28\",\n \"name\": \"Outgoing MyOperator IVR\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"29\",\n \"name\": \"Outgoing Mobile\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"30\",\n \"name\": \"Incoming Call\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"31\",\n \"name\": \"Incoming SMS\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"33\",\n \"name\": \"Outgoing Call \",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"34\",\n \"name\": \"Outgoing SMS\",\n \"parent_id\": \"25\"\n },\n {\n \"id\": \"36\",\n \"name\": \"Three word filters\",\n \"parent_id\": \"0\"\n },\n {\n \"id\": \"37\",\n \"name\": \"Incoming Connected Call\",\n \"parent_id\": \"36\"\n },\n {\n \"id\": \"38\",\n \"name\": \"Incoming Missed Call\",\n \"parent_id\": \"36\"\n },\n {\n \"id\": \"39\",\n \"name\": \"Unnoted\",\n \"parent_id\": \"21\"\n },\n {\n \"id\": \"40\",\n \"name\": \"ClickOcalls\",\n \"parent_id\": \"15\"\n },\n {\n \"id\": \"41\",\n \"name\": \"OBD Calls\",\n \"parent_id\": \"15\"\n },\n {\n \"id\": \"42\",\n \"name\": \"Callbacks\",\n \"parent_id\": \"15\"\n }\n ]\n}"}],"_postman_id":"6078a2b1-8acf-4ec2-addc-a4ae25671626"},{"name":"Get Recording Link","id":"d0a25f2d-3e32-4904-9921-5b9df0446548","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://developers.myoperator.co/search/recordings/link?token=&file","description":"The Recording Link API allows you to retrieve links for call recordings from your MyOperator account. This API provides access to call audio files using the recording file name obtained from call logs or callouts data.
\nRecording links are temporary and are valid for a limited duration.
\nThe API returns a recording link for the requested file.
\nfile parameter is required Unique MyOperator API token issued to the user who is accessing API.
\n","type":"text/plain"},"key":"token","value":""},{"description":{"content":"file name which is available in the callouts, sample : 4awerwf234353tgr123.mp3
\n","type":"text/plain"},"key":"file","value":null}],"variable":[]}},"response":[],"_postman_id":"d0a25f2d-3e32-4904-9921-5b9df0446548"}],"id":"ed0e6035-4dc7-4119-b7e9-04967f18a93b","description":"This documentation helps you implement the RESTful MyOperator API for accessing Call Logs.
\nThe API returns responses in JSON format and is stateless, meaning each request must be authenticated using an API token.
\nCall Logs APIs allow developers to retrieve call activity generated within a MyOperator account. These logs contain detailed information about calls handled through configured virtual numbers and can be used for reporting, analytics, CRM integrations, and operational monitoring.
\nTo obtain your API token:
\nLog in to your MyOperator Panel
\nNavigate to Manage → API Integration
\nCopy your Public API Token
\nAll API responses are returned in JSON format and include a status field.
When status = successThe response contains:
code
data array (for GET or POST requests)
For PUT requests, the response contains a success message instead of a data array.
\nWhen status = errorthe response contains:
code
message