{"info":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","description":"

🪐 Get Started

Steps to get started with the API:

Authorization: Use a valid API Token to send requests to the API endpoints.
\n
Base URL: https://api.dialer.io
\n

🔐 Authorization

The Dialer Client API uses an API Key for authorization.
\n
You must include an API key in each request to the API with the X-API-TOKEN request header.
\n

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute.

If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code. If your team is consistently hitting these limits, contact the Intergalactic API Product Owner, and we will work to accommodate you.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9498925","collectionId":"0ddc3956-829e-45d2-9e5f-4281a375a247","publishedId":"2sA3JT2dfb","public":true,"customColor":{"top-bar":"2563eb","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-20T05:22:21.000Z"},"item":[{"name":"Authorization","item":[{"name":"Validate API token","id":"a3f1c920-2ecb-4bc6-85c3-bae889fb0821","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.dialer.io/v1/tokens/api/check","description":"

Returns a successful or error message for validating an API token.

\n","urlObject":{"path":["v1","tokens","api","check"],"host":["https://api.dialer.io"],"query":[],"variable":[]}},"response":[{"id":"16e5fca0-9edb-4e5d-ba7a-afa53a79b8d3","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"X-API-TOKEN","value":"AAAAFI2LYZKOICPKTWRIC6BBBB","type":"text"}],"url":"https://api.dialer.io/v1/tokens/api/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"20"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:13:11 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"4"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\"\n}"},{"id":"db772a1a-f5bd-47e1-b7c3-8998c3f0e53f","name":"Invalid Response","originalRequest":{"method":"GET","header":[],"url":"https://api.dialer.io/v1/tokens/api/check"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:14:31 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"3"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"},{"id":"65f1e13c-dfe2-4740-a71f-f351bc19783b","name":"Error Response","originalRequest":{"method":"GET","header":[],"url":"https://api.dialer.io/v1/tokens/api/check"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Date","value":"Tue, 08 Apr 2025 08:51:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"45"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Vary","value":"X-API-TOKEN"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"}],"_postman_id":"a3f1c920-2ecb-4bc6-85c3-bae889fb0821"}],"id":"63af0062-49f3-46b1-9183-6b8f7e2e647a","description":"

📘 All requests to our API need authentication.

If you're working with an API token integration

The API token must be provided in the X-API-TOKEN header for all requests, for example:

curl --request GET \\\n--url \"https://api.dialer.io/v1/tokens/api/check\" \\\n--header \"X-API-TOKEN: 659c9fddb16335e48cc67114694b52074e812e03\"\n\n

\n","_postman_id":"63af0062-49f3-46b1-9183-6b8f7e2e647a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}}},{"name":"Contact Record","item":[{"name":"Add record to list","id":"64285635-e20b-48e2-babc-f5012f2f4403","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"\",\n \"number1\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lead_website\": \"\",\n \"lead_source\": \"\",\n \"time_to_call\": \"\",\n \"street\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"crm_reference\": \"\",\n \"crm_dial_attempts\": 0,\n \"crm_lead_score\": 0,\n \"crm_lead_creation_date\": \"\",\n \"lead_scheduling_link\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v2/web2campaign","description":"

Adds a new record to a list.

Request Body Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Property Type	Description	Required?
list	String	List name	Yes
number1	String	Phone number	Yes
first_name	String	First name	Yes
last_name	String	Last name	Yes
email	String	Email address	No
notes	String	Notes	No
lead_website	String	Lead website	No
lead_source	String	Lead source	No
time_to_call	String	Consideration Time	No
street	String	Street	No
city	String	City	No
state	String	State	No
zip	String	Zip	No
crm_reference	String	CRM Reference	No
crm_dial_attempts	Number	CRM Dial Attempts	No
crm_lead_score	Number	CRM Lead Score	No
crm_lead_creation_date	DateTime	CRM Lead Creation Date	No
lead_scheduling_link	String	Lead Scheduling Link	No

Response

{\n    \"code\": 0,\n    \"description\": \"The request was successfully processed\"\n}\n\n

\n","urlObject":{"path":["v2","web2campaign"],"host":["https://api.dialer.io"],"query":[],"variable":[]}},"response":[{"id":"f25e18e2-e0c6-424c-839c-78969daf9e93","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"cl-test-list-0000\",\n \"number1\": \"+61XXXXXXXXX\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@doe.com\",\n \"notes\": \"Potential customer interested in tech products.\",\n \"lead_website\": \"https://www.johndoe.com\",\n \"lead_source\": \"Referral\",\n \"time_to_call\": \"2025-01-16T10:00:00+11:00\",\n \"street\": \"123 Tech Street\",\n \"city\": \"Sydney\",\n \"state\": \"New South Wales\",\n \"zip\": \"2000\",\n \"crm_reference\": \"000X\",\n \"crm_dial_attempts\": 1,\n \"crm_lead_score\": 1,\n \"crm_lead_creation_date\": \"2025-01-16T10:00:00+11:00\",\n \"lead_scheduling_link\": \"https://calendly.com/juan-demo/30min\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v2/web2campaign"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"description\": \"The request was successfully processed\"\n}"},{"id":"da458fb3-6ea0-4edc-a2c0-6dc16b0ceb01","name":"Unauthorized Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"\",\n \"number1\": \"\",\n \"country_code\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lead_website\": \"\",\n \"lead_source\": \"\",\n \"call_asap\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v2/web2campaign"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:19:26 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"2"},{"key":"server","value":"envoy"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"},{"id":"fc6738c9-9222-4e35-baef-50eab186eedf","name":"Invalid Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"\",\n \"number1\": \"\",\n \"country_code\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lead_website\": \"\",\n \"lead_source\": \"\",\n \"call_asap\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v2/web2campaign"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"69"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:20:24 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"596"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"700\",\n \"description\": \"Mandatory field F9list missing\"\n}"}],"_postman_id":"64285635-e20b-48e2-babc-f5012f2f4403"},{"name":"Delete record from list","id":"c8b77117-f1cd-4648-9b34-36a3e893545a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"\",\n \"number\": \"\", // The number should be in international format with (+) prefix. Refer to the examples for guidance:\\nAU: +612XXXXXXX \\nUS: +1202XXXXXX\n \"crm_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-list","description":"

Delete record from a list.

Request Body Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Property Type	Description	Required?
list	String	List name	Yes
number	String	Phone number	Yes (Optional if CRM Reference is provided)
crm_reference	String	CRM Reference	Yes (Optional if number is provided)

Response

{\n    \"code\": 0,\n    \"description\": \"Records deleted: 0\"\n}\n\n

\n","urlObject":{"path":["v1","delete-record-from-list"],"host":["https://api.dialer.io"],"query":[],"variable":[]}},"response":[{"id":"3be35b55-bb32-4a99-9f44-2eb3958075cf","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"test-list\",\n \"number\": \"+12025550101\",\n \"crm_reference\": \"ACDBE-1320-900\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-list"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"description\": \"Records deleted: 1\"\n}"},{"id":"f88dedd7-39bc-420a-8f95-6b9c1b225a07","name":"Unauthorized Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"\",\n \"number\": \"\",\n \"crm_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:19:26 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"2"},{"key":"server","value":"envoy"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"},{"id":"06666e8b-951b-4b96-8551-6d306854e7f8","name":"Invalid Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"list\": \"\",\n \"number\": \"\",\n \"crm_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-list"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"69"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:20:24 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"596"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"700\",\n \"description\": \"Mandatory field F9list missing\"\n}"}],"_postman_id":"c8b77117-f1cd-4648-9b34-36a3e893545a"},{"name":"Delete record from all lists","id":"8320dbdf-b283-4612-b505-162d6e41349a","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"\", // The number should be in international format with (+) prefix. Refer to the examples for guidance:\\nAU: +612XXXXXXX \\nUS: +1202XXXXXX\n \"crm_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-all-list","description":"

Delete record from all lists.

Request Body Properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property Name	Property Type	Description	Required?
number	String	Phone number	Yes
crm_reference	String	CRM Reference	Yes (Optional if number is provided)

Response

{\n    \"code\": 0,\n    \"description\": \"The request was processed successfully. The number has been deleted from relevant lists.\"\n}\n\n

\n","urlObject":{"path":["v1","delete-record-from-all-list"],"host":["https://api.dialer.io"],"query":[],"variable":[]}},"response":[{"id":"5ead0aa8-2803-4be8-b623-da1ec943ead0","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"+12025550101\",\n \"crm_reference\": \"ACDBE-1320-900\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-all-list"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": 0,\n \"description\": \"The request was processed successfully. The number has been deleted from relevant lists.\"\n}"},{"id":"6800686a-1d57-45b9-bb3e-d80e7e5a5efb","name":"Unauthorized Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"\",\n \"crm_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-all-list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:19:26 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"2"},{"key":"server","value":"envoy"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"},{"id":"813abfc7-1954-4c2b-bf15-42e0544d6f1e","name":"Invalid Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"\",\n \"crm_reference\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/delete-record-from-all-list"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"69"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:20:24 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"596"},{"key":"server","value":"envoy"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"700\",\n \"description\": \"Mandatory field F9list missing\"\n}"}],"_postman_id":"8320dbdf-b283-4612-b505-162d6e41349a"}],"id":"541847b2-5380-43fb-9e60-c2fc8d0f0188","description":"

Contact Record

Actions:

Add record to list
\n
Delete record from list
\n
Delete record from all lists
\n

\n","_postman_id":"541847b2-5380-43fb-9e60-c2fc8d0f0188","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}}},{"name":"Webhook","item":[{"name":"Attach webhook","id":"e4820291-249c-4843-97b3-7ae78c609338","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"\",\n \"events\": [\"dial_created\"] // [\"transcription_available\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/webhooks","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}},"urlObject":{"path":["v1","webhooks"],"host":["https://api.dialer.io"],"query":[],"variable":[]}},"response":[{"id":"9f3dbe6d-1313-4c84-9580-b35143fb5823","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://www.example.com\",\n \"events\": [\"dial_created\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/webhooks"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"hook_id\": 1\n}"},{"id":"45680ce7-fe48-45cf-8a1f-cdd68d6d279c","name":"Unauthorized Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://www.example.com\",\n \"events\": [\"dial_created\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dialer.io/v1/webhooks"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:19:26 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"2"},{"key":"server","value":"envoy"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"}],"_postman_id":"e4820291-249c-4843-97b3-7ae78c609338"},{"name":"Detach webhook","id":"75e8083a-9a62-44cb-934d-51949cc39462","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.dialer.io/v1/webhooks/:hook_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}},"urlObject":{"path":["v1","webhooks",":hook_id"],"host":["https://api.dialer.io"],"query":[],"variable":[{"type":"any","value":"1","key":"hook_id"}]}},"response":[{"id":"c7477be1-749f-4d33-a8d5-abb2b15f9514","name":"Successful Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.dialer.io/v1/webhooks/:hook_id","host":["https://api.dialer.io"],"path":["v1","webhooks",":hook_id"],"variable":[{"key":"hook_id","value":"1"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"webhook deleted successfully\"\n}"},{"id":"7fc62e52-f4e1-4ec1-86fc-a86644dac918","name":"Unauthorized Response","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"url\": \"https://www.example.com\",\n \"events\": [\"dial_created\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.dialer.io/v1/webhooks/:hook_id","host":["https://api.dialer.io"],"path":["v1","webhooks",":hook_id"],"variable":[{"key":"hook_id","value":"1"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json"},{"key":"date","value":"Fri, 17 May 2024 09:19:26 GMT"},{"key":"vary","value":"X-API-TOKEN"},{"key":"x-envoy-upstream-service-time","value":"2"},{"key":"server","value":"envoy"},{"key":"connection","value":"close"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid or missing api token\"\n}"}],"_postman_id":"75e8083a-9a62-44cb-934d-51949cc39462"}],"id":"99e1c071-0f7a-49ae-99af-5a1ba31e5dff","description":"

Received webhook events for:
- dial_created
- lead_exhausted
- transcription_available

Actions:

Attach webhook
\n
Detach webhook
\n

\n","_postman_id":"99e1c071-0f7a-49ae-99af-5a1ba31e5dff","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}}},{"name":"Recording","item":[{"name":"Get download recording url","id":"bb5a1d9b-6d47-4ebb-8482-c447169a3f23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.dialer.io/v1/recordings/:dial_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}},"urlObject":{"path":["v1","recordings",":dial_id"],"host":["https://api.dialer.io"],"query":[],"variable":[{"type":"any","value":"","key":"dial_id"}]}},"response":[],"_postman_id":"bb5a1d9b-6d47-4ebb-8482-c447169a3f23"},{"name":"Download recording directly","id":"65118d36-5120-4fc4-96e3-493ee36d45ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://api.dialer.io/v1/recordings/:id/download","urlObject":{"path":["v1","recordings",":id","download"],"host":["https://api.dialer.io"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"65118d36-5120-4fc4-96e3-493ee36d45ff"}],"id":"d0d7245a-09ae-4865-a8c5-4a695cde13b0","description":"

Recordings

Actions:

Get Recording

\n","_postman_id":"d0d7245a-09ae-4865-a8c5-4a695cde13b0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}}},{"name":"Transcription","item":[{"name":"Get Transcription","id":"dabcf98b-9fd6-4d49-bb0c-27952a6d7cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.dialer.io/v1/transcriptions/:dial_id","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}},"urlObject":{"path":["v1","transcriptions",":dial_id"],"host":["https://api.dialer.io"],"query":[],"variable":[{"type":"any","value":"","key":"dial_id"}]}},"response":[],"_postman_id":"dabcf98b-9fd6-4d49-bb0c-27952a6d7cff"}],"id":"0f956a93-6aab-4b55-9625-85ac0cf010e8","description":"

Transcriptions

Actions:

Get Transcription

\n","_postman_id":"0f956a93-6aab-4b55-9625-85ac0cf010e8","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"0ddc3956-829e-45d2-9e5f-4281a375a247","id":"0ddc3956-829e-45d2-9e5f-4281a375a247","name":"Dialer Client API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-TOKEN"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"7a472699-1413-48bb-bc28-6335b0bd6ed3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e478705d-df50-4eb4-8886-9f17fcbdd7a6","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.dialer.io","type":"string"},{"key":"apiKey","value":"","type":"string"}]}

Table of contents:

🪐 Get Started

🔐 Authorization

Rate and usage limits

📘 All requests to our API need authentication.

If you're working with an API token integration

Request Body Properties

Response

Request Body Properties

Response

Request Body Properties

Response

Contact Record