Input Parameters
\nThis API request can be used for get list quick template that created in Barantum CRM. There are one parameter that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get List Quick Template API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"status\": 200,\n \"message\": \"success\",\n \"data\": {\n \"total_data\": 1,\n \"limit\": 15,\n \"prev_page\": 1,\n \"current_page\": 1,\n \"next_page\": \"\",\n \"last_page\": 1,\n \"total_page\": 1,\n \"data\": [\n {\n \"chat_template_serial_id\": 37,\n \"chat_template_uuid\": \"94bd40bd-203c-441c-b870-41e31c5d8bda\",\n \"chat_template_name\": \"template\",\n \"chat_template_message\": \"ini adalah template interactive\",\n \"chat_template_category\": \"ACCOUNT_UPDATE\",\n \"date_created\": \"2023-06-27 05:41:44\",\n \"chat_template_channel\": \"wa\",\n \"chat_template_type\": \"interactive\",\n \"chat_template_header\": \"\",\n \"chat_template_header_type\": \"text\",\n \"chat_template_footer\": \"\",\n \"chat_template_action_type\": \"reply_buttons\",\n \"chat_template_list_header\": \"\",\n \"chat_template_action\": \"[{\\\"title\\\":\\\"yes\\\",\\\"id\\\":\\\"a319d23e-a31d-4885-8915-206831c6fa86\\\"},{\\\"title\\\":\\\"no\\\",\\\"id\\\":\\\"00dbdbef-7c93-422b-b227-361eb60401a1\\\"}]\"\n }\n ]\n }\n}\n\nInput Parameters
\nSend a quick reply template message to a customer in an active chat room.
\nExpected Response
\n{\n \"status\": 200,\n \"message\": \"success\",\n \"data\": {\n \"customer_id\": \"62897187XXX\"\n }\n}\nInput Parameters
\nThis API request can be used for get expired time for a room with all categories in Barantum CRM. There are two parameters that are required as seen below in the table.
\nSee the API Response after sending the Get Expired Category API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"status\": 200,\n \"message\": \"Ok\",\n \"data\": {\n \"wa_users_id\": \"6281383xxxxxx\",\n \"wa_bot_id\": 30,\n \"wa_serial_id\": 441,\n \"data_initiated\": [\n {\n \"category\": \"marketing\",\n \"date_start\": \"2023-11-03 13:58:00\",\n \"date_end\": \"2023-11-04 13:58:00\"\n },\n {\n \"category\": \"authentication\",\n \"date_start\": \"2023-11-03 13:48:00\",\n \"date_end\": \"2023-11-04 13:48:00\"\n },\n {\n \"category\": \"utility\",\n \"date_start\": \"2023-11-03 13:43:00\",\n \"date_end\": \"2023-11-04 13:43:00\"\n },\n {\n \"category\": \"service\",\n \"date_start\": \"2023-11-03 13:36:00\",\n \"date_end\": \"2023-11-04 13:36:00\",\n \"status\": \"deactive\"\n },\n {\n \"category\": \"customer\",\n \"date_start\": \"2023-11-03 10:07:14\",\n \"date_end\": \"2023-11-04 10:07:14\"\n }\n ]\n }\n}\n\nRequired. API key / company UUID.
\n","type":"text/plain"},"key":"company_uuid","value":"{{company_uuid}}"},{"description":{"content":"Required. WhatsApp room serial ID.
\n","type":"text/plain"},"key":"wa_serial_id","value":"{{serial_id}}"}],"variable":[]}},"response":[],"_postman_id":"91055f15-078a-4861-b3f3-7c087e315d26"},{"name":"[Barantumchat] List Post (Facebook and Instagram)","id":"ea9780a4-6a3e-4fc1-b03c-1ff152caf091","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"company_uuid\": \"{{company_uuid}}\",\r\n \"channel\": \"{{channel}}\",\r\n \"bot_id\": \"{{bot_id}}\",\r\n \"filter\": {\r\n \"post_type\": \"TEXT | IMAGE | CAROUSEL\",\r\n \"post_id\": \"{{post_id}}\"\r\n },\r\n \"type_sort\": \"desc | asc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-chat.barantum.com/api/v1/get_list_post","description":"Input Parameters
\nThis API request can be used for get list posts in social media that is commented by your customer in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the List Post (Facebook and Instagram) API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"status\": 200,\n \"message\": \"OK\",\n \"data\": [\n {\n \"channel\": \"fb_post\",\n \"fb_post_id\": \"410169352177070_122098398530494123\",\n \"fb_post_type\": \"image\",\n \"fb_post_content\": \"\",\n \"fb_post_url\": \"https://s3.ap-southeast-1.amazonaws.com/crm.barantum.com-ap-southeast-1/company_1/20241223012931456205527_122097082454496058_6882095556547478123_n.jpg\",\n \"date_created\": \"23 December 2024 08:29:31\"\n }\n ]\n}\n\nInput Parameters
\nThis API request can be used for get list comments of specified post in social media that is commented by your customer in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the List Comment (Facebook and Instagram) API request to Barantum CRM for the complete list.
\nExample Request
\n{\n \"company_uuid\": \"f8c51792-8e1b-36ff-a7d0-8d2d655bdbed\",\n \"channel\": \"fb_post\",\n \"post_id\": \"410169352177070_122098398530494123\",\n \"filter\": {\n \"comment_id\": \"\",\n \"comment_type\": \"\"\n },\n \"type_sort\": \"desc\"\n}\n\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"status\": 200,\n \"message\": \"OK\",\n \"data\": [\n {\n \"channel\": \"fb_post\",\n \"post_id\": \"410169352177070_122098398530494123\",\n \"comment_type\": \"image\",\n \"comment_name\": \"Halaman Omni FB\",\n \"comment_content\": \"coba comment image\",\n \"comment_url\": \"https://s3.ap-southeast-1.amazonaws.com/crm.barantum.com-ap-southeast-1/company_1/Sir.Crocodile.600.3856123.jpg\",\n \"comment_id\": \"122098398530494101_478469841542123\",\n \"date_created\": \"24 December 2024 10:36:29\",\n \"comment_by\": \"agent\",\n \"comment_owner\": 2,\n \"comment_owner_name\": \"demo\"\n }\n ]\n}\n\nInput Parameters
\nThis API request can be used for submit comment to specified post or reply to specified comment of your audience in social media with Barantum. There are five parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Send/Reply Comment Text (Facebook and Instagram) API request to Barantum for the complete list.
\nExample Request
\n{\n \"post_id\": \"410169352177070_122098398530494123\",\n \"agent_id\": 2,\n \"channel\": \"fb_post\",\n \"company_uuid\": \"f8c51792-8e1b-36ff-a7d0-8d2d655bdbed\",\n \"bot_id\": \"5\",\n \"target_reply_id\": \"41016935216789_122098398532123\",\n \"comment_text\": \"ini merupakan contoh comment\"\n}\n\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"status\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"channel\": \"fb_post\",\n \"post_id\": \"410169352177070_122098398530494101\",\n \"comment_id\": \"122098398530494101_612766137977129\"\n }\n}\n\nThis API request can be used for submit comment with attachment to specified post or reply to specified comment of your audience in social media with Barantum. There are five parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Send/Reply Comment Media (Facebook and Instagram) API request to Barantum for the complete list.
\nExample Request
\n{\n \"post_id\": \"410169352177070_122098398530494123\",\n \"agent_id\": 2,\n \"channel\": \"fb_post\",\n \"company_uuid\": \"f8c51792-8e1b-36ff-a7d0-8d2d655bdbed\",\n \"bot_id\": \"5\",\n \"target_reply_id\": \"41016935216789_122098398532123\",\n\"type\": \"media\",\n \"media\": {\n \"caption\": \"coba comment image\",\n \"link\": \"https://s3.ap-southeast-1.amazonaws.com/crm.barantum.com-ap-southeast-1/company_1/Sir.Crocodile.600.3856123.jpg\"\n }\n}\n\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"status\": 200,\n \"message\": \"OK\",\n \"data\": {\n \"channel\": \"fb_post\",\n \"post_id\": \"410169352177070_122098398530494101\",\n \"comment_id\": \"122098398530494101_612766137977129\"\n }\n}\n\nInput Parameters
\nSend a typing indicator (read receipt) to a customer's WhatsApp room.
\nExpected Response
\nSuccess
\n{\n \"message\": \"Success\"\n}\nBot not found
\n{\n \"message\": \"Bot not found!\"\n}\nRoom not found
\n{\n \"message\": \"Room not found!\"\n}\nInput Parameters
\nSend an interactive WhatsApp message (list or button type) to an active chat room.
\ncontent_action.type_action values:
- \n
list— displays a scrollable list of options \nbutton— displays up to 3 quick-reply buttons \n
\n\nAn active chat room (status pending or in-progress) must exist with the customer before sending.
\n
Expected Response
\n{\n \"status\": 200,\n \"message\": \"success\",\n \"data\": { }\n}\nRequired. API key.
\n"},{"key":"bot_id","value":"{{bot_id}}","type":"text","description":"Required. WhatsApp bot ID.
\n"},{"key":"bot_type","value":"{{bot_type}}","type":"text","description":"Required. Bot type (e.g. cloud).
\n"},{"key":"file","value":"","type":"file","description":"Required. Media file to upload (image, video, document).
\n"}]},"url":"https://api-chat.barantum.com/api/v1/upload-media-template","description":"Input Parameters
\nUpload a media file to be used as a header in a WhatsApp broadcast template. Returns a Meta handle and a public S3 URL.
\n\nUse the returned
\nhandlein thetemplate_header_media_handlefield of Create WA Template.
Expected Response
\n{\n \"status\": 200,\n \"message\": \"ok\",\n \"handle\": \"4:xxxxxxxxxxxx\",\n \"url\": \"https://s3.ap-southeast-1.amazonaws.com/crm.barantum.document/...\"\n}\nInput Parameters
\nCreate a new WhatsApp broadcast template (MARKETING or UTILITY category).
\nButton types:
\n- \n
PHONE_NUMBER— requiresphoneCodeandphoneNumber\nURL— requiresurlandtype_url(static | dynamic) \nQUICK_REPLY— requirestextonly \nFLOW— requiresflow_id(use Get List WA Flow endpoint) \nCATALOG— text auto-set to \"View catalog\" \n
\n\nFor AUTHENTICATION templates, use the Create WA Template Auth endpoint instead.
\n
Expected Response
\n{\n \"status\": 200,\n \"message\": \"Template created successfully\",\n \"data\": { }\n}\nInput Parameters
\nCreate a new WhatsApp AUTHENTICATION category template (for OTP / login flows).
\n\n\n\n
COPY_CODE— user copies the OTP code manually.\nONE_TAP— Android auto-fills the OTP (requirespackage_name_authandsignature_hash_auth).
Expected Response
\n{\n \"status\": 200,\n \"message\": \"Authentication template created successfully\",\n \"data\": { }\n}\nInput Parameters
\nDelete a WhatsApp broadcast template from both Meta and Barantum CRM.
\n\n\nTemplate name is normalized to lowercase with underscores automatically.
\n
Expected Response
\n{\n \"status\": 200,\n \"message\": \"Template deleted successfully\"\n}\nInput Parameters
\nGet list of WhatsApp Flows for the company. Use flow_id values when creating a template with a FLOW button type.
\n\nAlternatively, send a POST request to this endpoint with pagination and
\nflow_namefilter in the body.
Expected Response
\n{\n \"status\": 200,\n \"message\": \"ok\",\n \"data\": [\n {\n \"flow_id\": \"1234567890\",\n \"flow_name\": \"My Customer Flow\"\n }\n ]\n}\nRequired. API key / company UUID.
\n","type":"text/plain"},"key":"company_uuid","value":"{{company_uuid}}"}],"variable":[]}},"response":[],"_postman_id":"7a92a88e-ada5-464e-81cf-0eb95eac9ef6"}],"id":"f3b03660-a0dc-4129-b5e3-776cbeaa3a8a","description":"Barantum Chat API Collection demonstrates how the data in the CRM works. This collection provides endpoints for adding or retrieving data details from the database.
\n\n\nThis API Collection is built on Barantum API Account. This means the data is dynamic and can be edited.
\n
Getting Started
\nTo start sending requests to the Barantum Chat API, make sure that you have an account in Barantum.com CRM.
\nGet API Key
\nIndonesian: Anda bisa mengikuti cara mendapatkan API Key ini melalui artikel kami dengan klik link berikut : https://support.barantum.com/faq/Cara-Generate-API-Token-pada-Barantum-CRM. Gunakan API Key ini pada variabel `company_uuid`.
\nEnglish: To get your API Key, you can follow this section
\n1. You must have an admin type account, then login on https://my.barantum.com.
\n2. On the right top of navbar, click the gear icon to access setting.
\n3. Click Developer Integration.
\n4. Generate token by click `+ Add Key` button.
\n5. On sidebar, please click `Generate Token` button to generate.
\n6. That key will be your `company_uuid` value.
\n","_postman_id":"f3b03660-a0dc-4129-b5e3-776cbeaa3a8a"},{"name":"Barantum CRM","item":[{"name":"Tickets","item":[{"name":"[Tickets] Save Data","id":"2793e326-4f6e-46a2-95ea-dab09df86c43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"token\" : \"{{vault:json-web-token}}\",\r\n \"module\" : \"Tickets\",\r\n \"data\" : {\r\n \"tickets_name\": \"Tickets Dummy 5\",\r\n \"tickets_person_name\": \"API Contacts Test\",\r\n \"tickets_description\": \"Tickets dummy test\",\r\n \"tickets_bulk_name\": \"10001359445762\",\r\n \"tickets_status\": 17,\r\n \"tickets_owner\": \"API Test\",\r\n \"tickets_contacts_uuid\": \"5ea1f586-43e6-446b-bd60-9a377fe9f2ef\"\r\n },\r\n \"data_custom\": {\r\n \"your_custom_field_name\": \"text value\",\r\n \"your_multioption_field_name\": [\"Option 1\", \"Option 2\"]\r\n }\r\n}\r\n"},"url":"https://rest-api.barantum.com/api/save_data","description":"Input Parameters
\nThis API request can be used for adding data to Tickets Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"17b55145-0ae7-45f0-a7c5-65af5ec61b73\",\n \"tickets_unique_id\": \"TICKETS-6326763\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Tickets Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Tickets Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": \"1\",\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"tickets_uuid\": \"ac683968-bac5-4a01-bb6b-3031656b50a4\",\n \"tickets_unique_id\": \"TICKETS-6303895\",\n \"tickets_name\": \"Test Edit API 22\",\n \"tickets_person_name\": \"API Contacts Test\",\n \"tickets_description\": \"Tickets dummy test\",\n \"tickets_status\": \"18\",\n \"tickets_owner\": \"API TEST\",\n \"date_created\": \"2022-07-28 10:59:17\",\n \"created_by\": \"API TEST\",\n \"date_modified\": \"2022-07-29 10:59:26\",\n \"modified_by\": \"API TEST\",\n \"deals_serial_id\": null,\n \"tickets_priority\": null,\n \"tickets_channel_type\": null,\n \"tickets_close_date\": null,\n \"tickets_expected_close_date\": \"2022-07-28 10:59:17\",\n \"tickets_source\": null,\n \"tickets_reason\": null,\n \"tickets_first_respon\": null,\n \"tickets_last_workflow\": null,\n \"tickets_last_workflow_date\": null,\n \"tickets_last_workflow_description\": null,\n \"tickets_reference\": null,\n \"first_activity_id\": 0,\n \"first_activity_module\": null,\n \"first_activity_date\": null,\n \"last_activity_id\": 0,\n \"last_activity_module\": null,\n \"last_activity_date\": null,\n \"upcoming_activity_id\": 0,\n \"upcoming_activity_module\": null,\n \"tickets_bulk_name\": \"10001359445762\",\n \"contacts\": [\n {\n \"contacts_salutation\": \"Mr.\",\n \"contacts_first_name\": \"API Contact\",\n \"contacts_last_name\": \"Test\",\n \"contacts_phone_mobile\": \"\",\n \"contacts_phone_work\": \"\"\n }\n ],\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Tickets Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Tickets Module is used to manage customer support tickets — tracking issues, complaints, or requests from creation to resolution. Tickets can be linked to a Contact record. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\",\n \"your_multioption_field_name\": [\"Option 1\", \"Option 2\"]\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Meetings Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"ad3f765b-f918-48db-a599-a128c83445b0\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Meetings Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Meetings Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"meetings_uuid\": \"c5e29ae7-443d-4356-bce8-b770284f773e\",\n \"meetings_unique_id\": \"MEETINGS-43942038159\",\n \"meetings_name\": \"Test API\",\n \"meetings_description\": \"\",\n \"meetings_location\": \"\",\n \"meetings_duration_hours\": \"00\",\n \"meetings_duration_minutes\": \"00\",\n \"meetings_date_start\": \"2022-07-28 09:22:00\",\n \"meetings_date_end\": \"2022-07-28 09:22:00\",\n \"meetings_status\": \"Planned\",\n \"meetings_check_in\": null,\n \"meetings_check_in_fake_location\": 0,\n \"meetings_check_out_fake_location\": 0,\n \"meetings_check_out\": null,\n \"meetings_check_out_status\": 0,\n \"meetings_check_out_reason\": \"\",\n \"meetings_owner\": \"API TEST\",\n \"deals_serial_id\": 0,\n \"date_created\": \"2022-07-28 16:22:30\",\n \"created_by\": \"API TEST\",\n \"date_modified\": null,\n \"modified_by\": \"-\",\n \"issue_serial_id\": 0,\n \"meetings_invitation\": 0,\n \"meetings_priority\": null,\n \"tickets_serial_id\": 0,\n \"meetings_lat\": \"0.0000000\",\n \"meetings_long\": \"0.0000000\",\n \"meetings_check_in_lat\": null,\n \"meetings_check_in_long\": null,\n \"users_uuid\": \"6b968640-693f-45ff-a04b-0b844401b455\",\n \"users_name\": \"API TEST\",\n \"related_leads_uuid\": \"-\",\n \"related_leads_name\": \"-\",\n \"related_contacts_uuid\": \"-\",\n \"related_contacts_name\": \"-\",\n \"related_org_uuid\": \"d4e2a745-82fa-4b58-8490-f682bff30959\",\n \"related_org_name\": \"Test Org\",\n \"related_deals_uuid\": \"-\",\n \"related_deals_name\": \"-\",\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Meetings Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Meetings Module is used to manage scheduled meetings and appointments. It supports check-in/check-out tracking with GPS coordinates. Meetings can be linked to Leads, Contacts, Org, or Deals. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\",\n \"your_multioption_field_name\": [\"Option 1\", \"Option 2\"]\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Leads Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"24d2cf03-2989-4d3a-af50-06eb0d19e5ed\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Leads Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Leads Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": \"1\",\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"leads_uuid\": \"0e785608-6213-4678-a990-dc8625ff5a87\",\n \"leads_unique_id\": \"LEADS-3181955\",\n \"leads_salutation\": null,\n \"leads_first_name\": \"John\",\n \"leads_last_name\": \"Doe\",\n \"leads_email\": \"johndoe@demo.com\",\n \"leads_picture\": null,\n \"leads_description\": null,\n \"leads_privacy\": 0,\n \"leads_birthdate\": null,\n \"leads_website\": null,\n \"leads_source\": null,\n \"leads_status\": null,\n \"leads_owner\": \"API TEST\",\n \"leads_job_title\": null,\n \"leads_job_department\": null,\n \"leads_role\": \"\",\n \"leads_organization_name\": null,\n \"leads_organization_industry\": null,\n \"leads_phone_home\": null,\n \"leads_phone_mobile\": null,\n \"leads_phone_work\": null,\n \"leads_phone_fax\": null,\n \"leads_address_maps\": null,\n \"leads_address_lat\": \"0\",\n \"leads_address_long\": \"0\",\n \"leads_address_street\": null,\n \"leads_address_city\": null,\n \"leads_address_state\": null,\n \"leads_address_postalcode\": null,\n \"leads_address_country\": null,\n \"date_created\": \"2022-07-28 10:59:03\",\n \"created_by\": \"API TEST\",\n \"date_modified\": \"2022-07-28 03:59:03\",\n \"modified_by\": \"-\",\n \"leads_first_assign\": null,\n \"leads_convert_id\": 0,\n \"leads_priority\": null,\n \"first_activity_id\": 0,\n \"first_activity_module\": null,\n \"first_activity_date\": null,\n \"last_activity_id\": 0,\n \"last_activity_module\": null,\n \"last_activity_date\": null,\n \"upcoming_activity_id\": 0,\n \"upcoming_activity_module\": null,\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Leads Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Leads Module is used to manage prospective customers (leads) before they are converted into Contacts or Deals. It supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\",\n \"your_multioption_field_name\": [\"Option 1\", \"Option 2\"]\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Deals Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"45f8e581-6679-4c52-8188-3ddab36148cf\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Deals Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Deals Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"deals_uuid\": \"0f1a6b95-80d5-48a2-905e-3f6bc70625e5\",\n \"deals_unique_id\": \"DEALS-43941279255\",\n \"deals_name\": \"Test\",\n \"deals_person_name\": [],\n \"deals_organization_name\": \"-\",\n \"deals_description\": \"\",\n \"deals_source\": \"\",\n \"deals_amount\": 300000,\n \"deals_close_date\": null,\n \"deals_expected_close_date\": \"2022-09-11 07:00:00\",\n \"deals_sales_stage\": \"Lead In\",\n \"deals_owner\": \"API TEST\",\n \"currency_serial_id\": \"Rp.\",\n \"date_created\": \"2022-07-28 11:19:32\",\n \"created_by\": \"API TEST\",\n \"date_modified\": null,\n \"modified_by\": \"-\",\n \"deals_lost_reason\": null,\n \"deals_comments\": \"\",\n \"deals_priority\": null,\n \"first_activity_id\": 0,\n \"first_activity_module\": null,\n \"first_activity_date\": null,\n \"last_activity_id\": 0,\n \"last_activity_module\": null,\n \"last_activity_date\": null,\n \"upcoming_activity_id\": 0,\n \"upcoming_activity_module\": null,\n \"deals_custom_text\": \"Hai\",\n \"deals_organization_uuid\": \"-\",\n \"sales_stage_name\": \"Lead In\",\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Deals Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Deals Module is used to manage sales opportunities and pipeline data. Deals can be linked to Contacts or Org, and tracked through sales stages. It supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\"\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Contacts Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"473d245a-bc23-47fa-97ba-8afc05983067\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Contacts Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Contacts Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"contacts_uuid\": \"555590e7-ff05-448b-a51e-324f268718e0\",\n \"contacts_unique_id\": \"CONTACTS-0132920621\",\n \"contacts_salutation\": null,\n \"contacts_first_name\": \"Ryan Arjuan Rante\",\n \"contacts_last_name\": null,\n \"contacts_email\": \"ryan.rante@outlook.com\",\n \"contacts_birthdate\": null,\n \"contacts_description\": null,\n \"contacts_title\": null,\n \"contacts_department\": null,\n \"contacts_role\": \"\",\n \"contacts_source\": \"instagram\",\n \"contacts_phone_home\": null,\n \"contacts_phone_mobile\": \"1676290916474061\",\n \"contacts_phone_work\": null,\n \"contacts_phone_fax\": null,\n \"contacts_address_maps\": null,\n \"contacts_address_lat\": \"0\",\n \"contacts_address_long\": \"0\",\n \"contacts_address_street\": null,\n \"contacts_address_city\": null,\n \"contacts_address_state\": null,\n \"contacts_address_postalcode\": null,\n \"contacts_address_country\": null,\n \"contacts_owner\": \"Demo\",\n \"contacts_ads_code\": null,\n \"contacts_related_keyword\": null,\n \"date_created\": \"2025-09-10 19:02:34\",\n \"date_converted\": null,\n \"created_by\": \"Demo\",\n \"date_modified\": \"2025-09-16 10:16:38\",\n \"modified_by\": \"Demo\",\n \"contacts_first_assign\": \"2025-09-10 12:02:34\",\n \"contacts_picture\": null,\n \"contacts_priority\": null,\n \"first_activity_id\": 0,\n \"first_activity_module\": null,\n \"first_activity_date\": null,\n \"last_activity_id\": 0,\n \"last_activity_module\": null,\n \"last_activity_date\": null,\n \"upcoming_activity_id\": 0,\n \"upcoming_activity_module\": null,\n \"contacts_last_workflow\": null,\n \"contacts_last_workflow_description\": null,\n \"contacts_last_workflow_date\": null,\n \"contacts_resign\": 0,\n \"contacts_primary\": 0,\n \"contacts_address_regencies\": null,\n \"contacts_address_districts\": null,\n \"contacts_address_villages\": null,\n \"last_completed_activity_id\": 0,\n \"last_completed_activity_module\": null,\n \"last_completed_activity_date\": null,\n \"contacts_available_status\": 0,\n \"contacts_ctext\": \"\",\n \"contacts_c_single_opt\": \"\",\n \"contacts_c_multiopt\": \"\",\n \"contacts_custom__numeric\": \"\",\n \"contacts_related_to__deals\": \"\",\n \"contacts_related_to__leads\": \"\",\n \"contacts_related_to__contacts\": \"\",\n \"contacts_related_to__org\": \"\",\n \"contacts_related_to__team\": \"\",\n \"contacts_related__user\": \"\",\n \"contacts_custom_phone\": \"\",\n \"contacts_ktp_20250220074538\": \"\",\n \"contacts_rtrw_20250220074551\": \"\",\n \"contacts_penjualan\": \"\",\n \"contacts_cuistomdate\": \"\",\n \"contacts_contact_status\": \"\",\n \"contacts_tampungan_predefine_source\": \"\",\n \"contacts_amount\": \"\",\n \"rel_to_module\": \"org\",\n \"org_uuid\": \"c666ec53-e1b3-4f1d-a23a-1bb0663f2281\",\n \"org_name\": \"testt\",\n \"org_unique_id\": null,\n \"users_uuid\": \"BARAID012\",\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Contacts Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Contacts Module is used to manage customer contact data. Contacts represent individuals and can be linked to Org, Deals, Tickets, and other records. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\",\n \"your_multioption_field_name\": [\"Option 1\", \"Option 2\"]\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Calls Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"922de59d-1e9f-4921-ac67-1805fd53dbe2\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Calls Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Calls Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"calls_uuid\": \"6487def6-2dea-4cce-9136-57f63832d46d\",\n \"calls_unique_id\": \"CALLS-43948195128\",\n \"calls_name\": \"UPDATE API 1\",\n \"calls_description\": null,\n \"calls_direction\": null,\n \"calls_status\": \"Planned\",\n \"calls_owner\": \"API TEST\",\n \"deals_serial_id\": 0,\n \"calls_duration_hours\": null,\n \"calls_duration_minutes\": null,\n \"calls_date_start\": \"2022-07-28 15:19:50\",\n \"calls_date_end\": null,\n \"date_created\": \"2022-07-28 15:19:50\",\n \"created_by\": \"API TEST\",\n \"date_modified\": \"2022-07-28 15:22:42\",\n \"modified_by\": \"API TEST\",\n \"recordingfile\": null,\n \"uniqueid\": null,\n \"billsec\": null,\n \"issue_serial_id\": 0,\n \"calls_priority\": null,\n \"tickets_serial_id\": 0,\n \"callcenter_calls_id\": 0,\n \"users_uuid\": \"6b968640-693f-45ff-a04b-0b844401b455\",\n \"users_name\": \"API TEST\",\n \"related_leads_uuid\": \"-\",\n \"related_leads_name\": \"-\",\n \"related_contacts_uuid\": \"1a2ca6c6-3d4c-4285-885c-e83cc02a4810\",\n \"related_contacts_name\": \"Alexander Cassidy\",\n \"related_org_uuid\": \"d4e2a745-82fa-4b58-8490-f682bff30959\",\n \"related_org_name\": \"Test Org\",\n \"related_deals_uuid\": \"-\",\n \"related_deals_name\": \"-\",\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Calls Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Calls Module is used to log and track call activities. Calls can be linked to Contacts, Leads, or Deals to maintain a complete communication history. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\",\n \"your_multioption_field_name\": [\"Option 1\", \"Option 2\"]\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Org Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"8f9cda08-7bec-48ba-a1ab-0ce45faf432a\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Org Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Org Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
JSON
\n{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"org_uuid\": \"d4e2a745-82fa-4b58-8490-f682bff30959\",\n \"org_unique_id\": null,\n \"org_name\": \"DeepMind Corp 2\",\n \"org_email\": \"info@deepmindx.com\",\n \"org_description\": \"AI Demo X\",\n \"org_industry\": null,\n \"org_website\": null,\n \"org_phone_mobile\": \"621110000222\",\n \"org_phone_work\": \"62217890098\",\n \"org_phone_other\": null,\n \"org_phone_fax\": null,\n \"org_address_maps\": null,\n \"org_address_lat\": \"0\",\n \"org_address_long\": \"0\",\n \"org_address_street\": \"Jl. Sudirman, Balikpapan. Indonesia\",\n \"org_address_city\": null,\n \"org_address_state\": null,\n \"org_address_postalcode\": null,\n \"org_address_country\": null,\n \"org_owner\": \"API TEST\",\n \"org_sales_type\": \"Pre-sales\",\n \"date_created\": \"2022-07-28 15:35:30\",\n \"created_by\": \"API TEST\",\n \"date_modified\": null,\n \"modified_by\": \"-\",\n \"org_first_assign\": null,\n \"org_picture\": null,\n \"org_parent_id\": \"None\",\n \"org_priority\": null,\n \"first_activity_id\": 0,\n \"first_activity_module\": null,\n \"first_activity_date\": null,\n \"last_activity_id\": 0,\n \"last_activity_module\": null,\n \"last_activity_date\": null,\n \"upcoming_activity_id\": 0,\n \"upcoming_activity_module\": null,\n \"org_business_entity\": null,\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Org Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Org Module is used to manage organization or company data. Org records can be linked to Contacts and Deals. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\"\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Notes Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"21ce4680-b467-43fc-b64e-8ebf19096953\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Notes Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Notes Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
JSON
\n{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"notes_uuid\": \"d157f24a-61e1-4732-b30a-588009afe9f8\",\n \"notes_unique_id\": \"NOTES-43947201510\",\n \"notes_name\": \"Notes demo via API 2\",\n \"notes_file_mime_type\": null,\n \"notes_filename\": null,\n \"notes_contact_id\": null,\n \"notes_description\": null,\n \"notes_owner\": \"-\",\n \"deals_serial_id\": 0,\n \"date_created\": \"2022-07-28 16:14:58\",\n \"created_by\": \"API TEST\",\n \"date_modified\": null,\n \"modified_by\": \"-\",\n \"issue_serial_id\": 0,\n \"notes_priority\": null,\n \"tickets_serial_id\": 0,\n \"users_uuid\": \"6b968640-693f-45ff-a04b-0b844401b455\",\n \"users_name\": \"API TEST\",\n \"related_leads_uuid\": \"-\",\n \"related_leads_name\": \"-\",\n \"related_contacts_uuid\": \"-\",\n \"related_contacts_name\": \"-\",\n \"related_org_uuid\": \"d4e2a745-82fa-4b58-8490-f682bff30959\",\n \"related_org_name\": \"Test Org\",\n \"related_deals_uuid\": \"-\",\n \"related_deals_name\": \"-\",\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Notes Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Notes Module is used to add internal notes to other CRM records. Notes can be linked to Contacts, Org, Leads, or Deals via the corresponding UUID relation fields. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\"\n }\n}\nInput Parameters
\nThis API request can be used for adding data to Tasks Module in Barantum CRM. There are four parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true,\n \"uuid\": \"dc5c065f-c12c-48ac-884a-64772ab02244\"\n}\n\nInput Parameters
\nThis API request can be used for editing data from Tasks Module in Barantum CRM. There are three parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the Get Data API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nInput Parameters
\nThis API request can be used for getting list data from Tasks Module in Barantum CRM. There are two parameters that are required and the others are optional as seen below in the table.
\nSee the API Response after sending the API request to Barantum CRM for the complete list.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": {\n \"total\": 1,\n \"page_total\": 1,\n \"page_last\": 1,\n \"page_first\": 1,\n \"per_page\": 20,\n \"page_current\": 1,\n \"page_previous\": 0,\n \"page_next\": 2,\n \"content\": [\n {\n \"tasks_uuid\": \"d05a64b0-3e76-4f59-9343-9b2c74bf3e8e\",\n \"tasks_unique_id\": \"TASKS-4394427481\",\n \"tasks_name\": \"UPDATE API 1 Update Tasks2\",\n \"tasks_description\": \"Ini dari hit API\",\n \"tasks_status\": \"Planned\",\n \"tasks_date_start\": \"2022-11-18 12:12:34\",\n \"tasks_date_due\": \"2022-11-20 10:10:34\",\n \"tasks_contact_id\": null,\n \"tasks_priority\": null,\n \"tasks_owner\": \"API TEST\",\n \"deals_serial_id\": 0,\n \"date_created\": \"2022-07-28 16:15:31\",\n \"created_by\": \"API TEST\",\n \"date_modified\": \"2022-07-28 16:20:10\",\n \"modified_by\": \"API TEST\",\n \"issue_serial_id\": 0,\n \"tickets_serial_id\": 0,\n \"tasks_held_reason\": null,\n \"users_uuid\": \"6b968640-693f-45ff-a04b-0b844401b455\",\n \"users_name\": \"API TEST\",\n \"related_leads_uuid\": \"-\",\n \"related_leads_name\": \"-\",\n \"related_contacts_uuid\": \"-\",\n \"related_contacts_name\": \"-\",\n \"related_org_uuid\": \"d4e2a745-82fa-4b58-8490-f682bff30959\",\n \"related_org_name\": \"Test Org\",\n \"related_deals_uuid\": \"-\",\n \"related_deals_name\": \"-\",\n \"attachments\": []\n }\n ]\n }\n}\n\nInput Parameters
\nThis API request can be used for deleting data from Tasks Module in Barantum CRM. There are three parameters that are required as seen below in the table.
\nExpected Response
\nThe API request will return a response whether the request failed or succeeded. The response will be 401 Unauthorized if it failed and if it succeeded, it will return as written below.
{\n \"code\": \"200\",\n \"result\": true\n}\n\nThe Tasks Module is used to manage to-do tasks and activities. Supports scheduling with start and due dates. Supports additional custom fields via data_custom.
\n\nYou must have a Barantum CRM account to use this API.
\n
Key fields:
\nCustom fields are sent via data_custom. The key is the custom field name configured in CRM Settings → Custom Fields:
{\n \"data_custom\": {\n \"your_custom_field_name\": \"text value\"\n }\n}\nLogin Authorization
\nTo start using this Barantum CRM Public API, you need to login to the CRM (via API) using your Barantum CRM account.
\nAfter receiving the API response, copy the token from the result that will be used for hitting the Barantum Public API.
\nExpected Response
\n{\n \"code\": \"200\",\n \"result\": \"{{vault:json-web-token}}\"\n}\n\nThe Barantum CRM API enables programmatic management of data across 9 core CRM modules: Leads, Contacts, Deals, Tickets, Meetings, Calls, Org, Notes, and Tasks.
\nAll CRM operations use 4 unified REST endpoints. The target module is specified via the module parameter in the request body. Authentication is done by passing a JWT token in the token field of each request body.
Use the Auth Login endpoint to obtain your JWT token before making any requests.
\n","_postman_id":"4a3fc8b1-b553-4586-90fb-c4c48ed174be"},{"name":"Barantum Webhook Chat","item":[{"name":"Whatsapp","item":[{"name":"Text","id":"c164e76a-20eb-4303-b95d-8cff5e86ca41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"Hi, welcome\",\r\n \"type_file\" : \"text\",\r\n \"file_name\" : \"\",\r\n \"file_url\" : \"\",\r\n \"file_mime_type\" : \"\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"c164e76a-20eb-4303-b95d-8cff5e86ca41"},{"name":"Image","id":"09f9ba85-0f42-4893-91fd-09e803f48369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"Hi, welcome\",\r\n \"type_file\" : \"image\",\r\n \"file_name\" : \"image.png\",\r\n \"file_url\" : \"https://some-storage.com/image.png\",\r\n \"file_mime_type\" : \"image/png\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"09f9ba85-0f42-4893-91fd-09e803f48369"},{"name":"Document","id":"36c5960a-1069-45f0-9cbd-96802b592ccd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"Hi, welcome\",\r\n \"type_file\" : \"document\",\r\n \"file_name\" : \"document.docx\",\r\n \"file_url\" : \"https://some-storage.com/document.docx\",\r\n \"file_mime_type\" : \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"36c5960a-1069-45f0-9cbd-96802b592ccd"},{"name":"Location","id":"6dfd95a0-cb04-41d8-a7a7-bda955a42de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Renhard\",\r\n \"room_id\": 2384689,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"6282121366322\",\r\n \"message_id\": \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"location\",\r\n \"location\": {\r\n \"lat\": -3.1208301,\r\n \"lng\": 3.1208301\r\n },\r\n \"file_name\": \"\",\r\n \"file_url\": \"\",\r\n \"file_mime_type\": \"\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"wa\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6dfd95a0-cb04-41d8-a7a7-bda955a42de5"},{"name":"Audio","id":"36b5961d-feee-44c8-b1d4-d441b9588504","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"\",\r\n \"type_file\" : \"audio\",\r\n \"file_name\" : \"audio.mp3\",\r\n \"file_url\" : \"https://some-storage.com/audio.mp3\",\r\n \"file_mime_type\" : \"audio/mpeg\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"36b5961d-feee-44c8-b1d4-d441b9588504"},{"name":"Voice","id":"bf09d741-1859-4c58-8d89-aa7792fa89ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"\",\r\n \"type_file\" : \"voice\",\r\n \"file_name\" : \"voice.ogg\",\r\n \"file_url\" : \"https://some-storage.com/voice.ogg\",\r\n \"file_mime_type\" : \"audio/ogg\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bf09d741-1859-4c58-8d89-aa7792fa89ef"},{"name":"Video","id":"ef136507-65b2-4179-897c-e386e76e24d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"\",\r\n \"type_file\" : \"video\",\r\n \"file_name\" : \"video.mp4\",\r\n \"file_url\" : \"https://some-storage.com/video.mp4\",\r\n \"file_mime_type\" : \"video/mp4\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ef136507-65b2-4179-897c-e386e76e24d3"},{"name":"Sticker","id":"5ce10094-101e-46cc-9b8e-be46f9a359c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"\",\r\n \"type_file\" : \"sticker\",\r\n \"file_name\" : \"sticker.svg\",\r\n \"file_url\" : \"https://some-storage.com/sticker.svg\",\r\n \"file_mime_type\" : \"image/svg+xml\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"5ce10094-101e-46cc-9b8e-be46f9a359c4"},{"name":"Contacts","id":"5f372135-e61d-436d-b4b0-c87adbaae437","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"{\\\"name\\\":\\\"Baba\\\",\\\"phone\\\":\\\"+62 821-2256-6397\\\"}\",\r\n \"type_file\" : \"contacts\",\r\n \"file_name\" : \"\",\r\n \"file_url\" : \"\",\r\n \"file_mime_type\" : \"\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"5f372135-e61d-436d-b4b0-c87adbaae437"},{"name":"Reaction","id":"13292493-9118-4836-ab59-f0b1bf2ef3e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"👏\",\r\n \"type_file\" : \"reaction\",\r\n \"file_name\" : \"\",\r\n \"file_url\" : \"\",\r\n \"file_mime_type\" : \"\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8,\r\n \"context\": {\r\n \"from\": \"\",\r\n \"message_id\": \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABEYEjM5NkU1NkEzMDU3RUVDNzEyNQA=\",\r\n \"type\": \"text\",\r\n \"message\": \"hoi\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"13292493-9118-4836-ab59-f0b1bf2ef3e8"},{"name":"Error","id":"86ba5603-eea9-4615-ac1c-b73cb10a5fe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\" : \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\" : \"Renhard\",\r\n \"room_id\" : 2384689,\r\n \"room_status\" : \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\" : \"2024-11-20 01:19:34\",\r\n \"company_uuid\" : \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\" : \"6282121366322\",\r\n \"message_id\" : \"wamid.HBgNNjI4MjEyMjU2NjM5NxUCABIYFDNGNENGREY0NDQ2MjY3QjZCRUNGAA==\",\r\n \"message_text\" : \"Message type is currently not supported.\",\r\n \"type_file\" : \"errors\",\r\n \"file_name\" : \"\",\r\n \"file_url\" : \"\",\r\n \"file_mime_type\" : \"\",\r\n \"owner\" : 88,\r\n \"name_owner\" : \"Testing\",\r\n \"channel\" : \"wa\",\r\n \"bot_id\" : 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"86ba5603-eea9-4615-ac1c-b73cb10a5fe6"}],"id":"eb696fa9-46aa-40fc-b7b2-52037fe4d3b0","description":"This is for channel Whatsapp.
\n","_postman_id":"eb696fa9-46aa-40fc-b7b2-52037fe4d3b0"},{"name":"Facebook","item":[{"name":"Text","id":"fb7bf47b-8313-430a-b71c-394790b40954","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"John Doe\",\r\n \"room_id\": 2384690,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"1234567890\",\r\n \"message_id\": \"m_abc123xyz456def789\",\r\n \"message_text\": \"Hello, I need help!\",\r\n \"type_file\": \"text\",\r\n \"file_name\": \"\",\r\n \"file_url\": \"\",\r\n \"file_mime_type\": \"\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"fb\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"fb7bf47b-8313-430a-b71c-394790b40954"},{"name":"Image","id":"8bd7171d-58c7-4cb1-a320-baad8e6586b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"John Doe\",\r\n \"room_id\": 2384690,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"1234567890\",\r\n \"message_id\": \"m_abc123xyz456def789\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"image\",\r\n \"file_name\": \"image.jpg\",\r\n \"file_url\": \"https://some-storage.com/image.jpg\",\r\n \"file_mime_type\": \"image/jpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"fb\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8bd7171d-58c7-4cb1-a320-baad8e6586b0"},{"name":"Document","id":"7803ec52-f955-4908-966f-7c8d31552760","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"John Doe\",\r\n \"room_id\": 2384690,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"1234567890\",\r\n \"message_id\": \"m_abc123xyz456def789\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"document\",\r\n \"file_name\": \"document.pdf\",\r\n \"file_url\": \"https://some-storage.com/document.pdf\",\r\n \"file_mime_type\": \"application/pdf\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"fb\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"7803ec52-f955-4908-966f-7c8d31552760"},{"name":"Audio","id":"4a4c4985-c7c6-4714-89e8-e773108fff1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"John Doe\",\r\n \"room_id\": 2384690,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"1234567890\",\r\n \"message_id\": \"m_abc123xyz456def789\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"audio\",\r\n \"file_name\": \"audio.mp3\",\r\n \"file_url\": \"https://some-storage.com/audio.mp3\",\r\n \"file_mime_type\": \"audio/mpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"fb\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"4a4c4985-c7c6-4714-89e8-e773108fff1d"},{"name":"Video","id":"53f0cfe5-abdd-42eb-9489-d4e8d8680b51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"John Doe\",\r\n \"room_id\": 2384690,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"1234567890\",\r\n \"message_id\": \"m_abc123xyz456def789\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"video\",\r\n \"file_name\": \"video.mp4\",\r\n \"file_url\": \"https://some-storage.com/video.mp4\",\r\n \"file_mime_type\": \"video/mp4\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"fb\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"53f0cfe5-abdd-42eb-9489-d4e8d8680b51"}],"id":"9dc46e09-0358-4554-857f-b4dacb76570d","description":"This is for channel Facebook.
\n","_postman_id":"9dc46e09-0358-4554-857f-b4dacb76570d"},{"name":"Instagram","item":[{"name":"Text","id":"65e66fa6-3386-4203-bc69-e3a8be56825d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Jane Doe\",\r\n \"contacts_username\": \"janedoe_ig\",\r\n \"room_id\": 2384691,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"17841400000000001\",\r\n \"message_id\": \"aWdfZGVmYWJjMTIzNDU2\",\r\n \"message_text\": \"Hello, I need help!\",\r\n \"type_file\": \"text\",\r\n \"file_name\": \"\",\r\n \"file_url\": \"\",\r\n \"file_mime_type\": \"\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"ig\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"65e66fa6-3386-4203-bc69-e3a8be56825d"},{"name":"Image","id":"f68c931d-0aac-4101-82b1-8b9bfb29dea3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Jane Doe\",\r\n \"contacts_username\": \"janedoe_ig\",\r\n \"room_id\": 2384691,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"17841400000000001\",\r\n \"message_id\": \"aWdfZGVmYWJjMTIzNDU2\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"image\",\r\n \"file_name\": \"image.jpg\",\r\n \"file_url\": \"https://some-storage.com/image.jpg\",\r\n \"file_mime_type\": \"image/jpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"ig\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"f68c931d-0aac-4101-82b1-8b9bfb29dea3"},{"name":"Document","id":"f15adb03-8c4e-4ef8-8939-b839c1dbcc67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Jane Doe\",\r\n \"contacts_username\": \"janedoe_ig\",\r\n \"room_id\": 2384691,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"17841400000000001\",\r\n \"message_id\": \"aWdfZGVmYWJjMTIzNDU2\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"document\",\r\n \"file_name\": \"document.pdf\",\r\n \"file_url\": \"https://some-storage.com/document.pdf\",\r\n \"file_mime_type\": \"application/pdf\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"ig\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"f15adb03-8c4e-4ef8-8939-b839c1dbcc67"},{"name":"Audio","id":"d0902dc7-7c4f-4021-b38d-033a5e65309a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Jane Doe\",\r\n \"contacts_username\": \"janedoe_ig\",\r\n \"room_id\": 2384691,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"17841400000000001\",\r\n \"message_id\": \"aWdfZGVmYWJjMTIzNDU2\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"audio\",\r\n \"file_name\": \"audio.mp3\",\r\n \"file_url\": \"https://some-storage.com/audio.mp3\",\r\n \"file_mime_type\": \"audio/mpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"ig\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"d0902dc7-7c4f-4021-b38d-033a5e65309a"},{"name":"Video","id":"05e68a07-fb80-42a2-a5d7-5578ff83d0c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Jane Doe\",\r\n \"contacts_username\": \"janedoe_ig\",\r\n \"room_id\": 2384691,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"17841400000000001\",\r\n \"message_id\": \"aWdfZGVmYWJjMTIzNDU2\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"video\",\r\n \"file_name\": \"video.mp4\",\r\n \"file_url\": \"https://some-storage.com/video.mp4\",\r\n \"file_mime_type\": \"video/mp4\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"ig\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"05e68a07-fb80-42a2-a5d7-5578ff83d0c0"}],"id":"4c8bedd6-00fa-44b6-be8c-949876532199","description":"This is for channel Instagram.
\n","_postman_id":"4c8bedd6-00fa-44b6-be8c-949876532199"},{"name":"Telegram","item":[{"name":"Text","id":"c232f830-42ec-4648-9f18-7abb980bd806","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Alex Smith\",\r\n \"room_id\": 2384692,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"123456789\",\r\n \"message_id\": \"12345\",\r\n \"message_text\": \"Hello, I need help!\",\r\n \"type_file\": \"text\",\r\n \"file_name\": \"\",\r\n \"file_url\": \"\",\r\n \"file_mime_type\": \"\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"telegram\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"c232f830-42ec-4648-9f18-7abb980bd806"},{"name":"Image","id":"5d54bb96-d343-404a-9ae7-68c63618fc05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Alex Smith\",\r\n \"room_id\": 2384692,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"123456789\",\r\n \"message_id\": \"12345\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"image\",\r\n \"file_name\": \"image.jpg\",\r\n \"file_url\": \"https://some-storage.com/image.jpg\",\r\n \"file_mime_type\": \"image/jpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"telegram\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"5d54bb96-d343-404a-9ae7-68c63618fc05"},{"name":"Document","id":"b70bb980-b2b9-4685-8f09-83e456d03b33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Alex Smith\",\r\n \"room_id\": 2384692,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"123456789\",\r\n \"message_id\": \"12345\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"document\",\r\n \"file_name\": \"document.pdf\",\r\n \"file_url\": \"https://some-storage.com/document.pdf\",\r\n \"file_mime_type\": \"application/pdf\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"telegram\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"b70bb980-b2b9-4685-8f09-83e456d03b33"},{"name":"Audio","id":"15fb7072-d3ad-4877-be9a-9e6ee763d616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Alex Smith\",\r\n \"room_id\": 2384692,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"123456789\",\r\n \"message_id\": \"12345\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"audio\",\r\n \"file_name\": \"audio.mp3\",\r\n \"file_url\": \"https://some-storage.com/audio.mp3\",\r\n \"file_mime_type\": \"audio/mpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"telegram\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"15fb7072-d3ad-4877-be9a-9e6ee763d616"},{"name":"Video","id":"8aa83f4e-7cc7-4b98-b777-45a1efeb72d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Alex Smith\",\r\n \"room_id\": 2384692,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"123456789\",\r\n \"message_id\": \"12345\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"video\",\r\n \"file_name\": \"video.mp4\",\r\n \"file_url\": \"https://some-storage.com/video.mp4\",\r\n \"file_mime_type\": \"video/mp4\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"telegram\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8aa83f4e-7cc7-4b98-b777-45a1efeb72d3"}],"id":"65ee2f12-2aad-4b5e-a034-3a687cef1afe","description":"This is for channel Telegram.
\n","_postman_id":"65ee2f12-2aad-4b5e-a034-3a687cef1afe"},{"name":"Line","item":[{"name":"Text","id":"90ebdfe0-eb4e-40ba-856f-298adbb54117","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Sora Tanaka\",\r\n \"room_id\": 2384693,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"Udeadbeefdeadbeef12345678901234\",\r\n \"message_id\": \"100001\",\r\n \"message_text\": \"Hello, I need help!\",\r\n \"type_file\": \"text\",\r\n \"file_name\": \"\",\r\n \"file_url\": \"\",\r\n \"file_mime_type\": \"\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"line\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"90ebdfe0-eb4e-40ba-856f-298adbb54117"},{"name":"Image","id":"fe62076d-05ce-40de-8ef1-a58a683fed1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Sora Tanaka\",\r\n \"room_id\": 2384693,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"Udeadbeefdeadbeef12345678901234\",\r\n \"message_id\": \"100001\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"image\",\r\n \"file_name\": \"image.jpg\",\r\n \"file_url\": \"https://some-storage.com/image.jpg\",\r\n \"file_mime_type\": \"image/jpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"line\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"fe62076d-05ce-40de-8ef1-a58a683fed1c"},{"name":"Document","id":"bb7a011c-2755-494b-ad0f-bc0b5268c525","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Sora Tanaka\",\r\n \"room_id\": 2384693,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"Udeadbeefdeadbeef12345678901234\",\r\n \"message_id\": \"100001\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"document\",\r\n \"file_name\": \"document.pdf\",\r\n \"file_url\": \"https://some-storage.com/document.pdf\",\r\n \"file_mime_type\": \"application/pdf\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"line\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"bb7a011c-2755-494b-ad0f-bc0b5268c525"},{"name":"Audio","id":"ff51b2ca-e3d1-45f9-9503-f2540c66a369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Sora Tanaka\",\r\n \"room_id\": 2384693,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"Udeadbeefdeadbeef12345678901234\",\r\n \"message_id\": \"100001\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"audio\",\r\n \"file_name\": \"audio.mp3\",\r\n \"file_url\": \"https://some-storage.com/audio.mp3\",\r\n \"file_mime_type\": \"audio/mpeg\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"line\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"ff51b2ca-e3d1-45f9-9503-f2540c66a369"},{"name":"Video","id":"c4a5ba7e-5a41-4ae1-a225-5c8e44ce3ae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\r\n \"contacts_uuid\": \"8a29a961-e69d-4922-80ed-e92eee2afff1\",\r\n \"contacts_name\": \"Sora Tanaka\",\r\n \"room_id\": 2384693,\r\n \"room_status\": \"pending|in-progress|done-waiting|done\",\r\n \"room_date_created\": \"2024-11-20 01:19:34\",\r\n \"company_uuid\": \"a3bed9a9-f6aa-4cd8-9f3f-3cbf8728eb7d\",\r\n \"message_users_id\": \"Udeadbeefdeadbeef12345678901234\",\r\n \"message_id\": \"100001\",\r\n \"message_text\": \"\",\r\n \"type_file\": \"video\",\r\n \"file_name\": \"video.mp4\",\r\n \"file_url\": \"https://some-storage.com/video.mp4\",\r\n \"file_mime_type\": \"video/mp4\",\r\n \"owner\": 88,\r\n \"name_owner\": \"Testing\",\r\n \"channel\": \"line\",\r\n \"bot_id\": 8\r\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is an expected data that you will received from our webhook.
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"c4a5ba7e-5a41-4ae1-a225-5c8e44ce3ae1"}],"id":"a078c7f5-24bb-4886-816e-d82a1a5291b1","description":"This is for channel Line.
\n","_postman_id":"a078c7f5-24bb-4886-816e-d82a1a5291b1"}],"id":"4b689f9e-54f4-4830-9f79-0424420170f8","description":"This is documentation about the data sent by Barantum with Send Webhook at chat features.
\nPrerequisite
\n- \n
You have developer team to handle this.
\n \nEnable Send Webhook Inbound and fill Send Webhook Endpoint When Inbound, then click Save button under the page. You can fill this as an admin user under page Barantumchat Settings then access General Settings.
\n \nMake sure your endpoint is available online. If you still on development, you can use either your sandbox or ngrok for receiving the data.
\n \n
Retrieve Registered Extensions
\nMethod: GET
URL: {{domain}}/app/api/extensions/api-key{{{apiKey}}}
Description
\nThis endpoint is used to retrieve the API key associated with the user's account. It is essential for authenticating subsequent requests to the API.
\nRequest Parameters
\n- \n
\ndomain: The unique identifier for your company given cloudpbx server. This is received by request tosupport@barantum.comand our sales will contact you for the detail. \napiKey (path parameter): The unique identifier for the user's API key. This key is required to access the API and should be included in the URL. You will also get the API key after get the domain value.
\n \n
Response Structure
\nThe response will contain the following:
\n- \n
Status Code:
\n- \n
\n200- This indicates that the request API key is success. \n
\n404- This indicates that the requested API key was not found. \n
\nContent-Type:
\n- \n
application/json\n
\nResponse Body:
\n- \n
- List extensions in array collection. \n
\nResponse Error:
\n- \n
\nmessage: A string that provides additional information about the status of the request.- \n
API not found.: Message indicate you should check if your API key is valid or not. Also make sure the key is inserted between{and}. \n
\n
\n
Example Response Success
\n[\n {\n \"extension_uuid\": \"05f73de6-a623-4613-ab9f-8bf21674ef65\",\n \"domain_uuid\": \"325f7473-5973-4501-8450-75c5bfa824db\",\n \"extension\": \"789\",\n \"number_alias\": null,\n \"password\": \"PASSWORD\",\n \"accountcode\": \"DOMAIN\",\n \"effective_caller_id_name\": null,\n \"effective_caller_id_number\": null,\n \"outbound_caller_id_name\": null,\n \"outbound_caller_id_number\": null,\n \"emergency_caller_id_name\": null,\n \"emergency_caller_id_number\": null,\n \"directory_first_name\": null,\n \"directory_last_name\": null,\n \"directory_visible\": \"true\",\n \"directory_exten_visible\": \"true\",\n \"max_registrations\": null,\n \"limit_max\": \"5\",\n \"limit_destination\": \"!USER_BUSY\",\n \"missed_call_app\": null,\n \"missed_call_data\": null,\n \"user_context\": \"DOMAIN\",\n \"toll_allow\": null,\n \"call_timeout\": \"30\",\n \"call_group\": null,\n \"call_screen_enabled\": \"false\",\n \"user_record\": \"all\",\n \"hold_music\": null,\n \"auth_acl\": null,\n \"cidr\": null,\n \"sip_force_contact\": null,\n \"nibble_account\": null,\n \"sip_force_expires\": null,\n \"mwi_account\": null,\n \"sip_bypass_media\": null,\n \"unique_id\": null,\n \"dial_string\": null,\n \"dial_user\": null,\n \"dial_domain\": null,\n \"do_not_disturb\": null,\n \"forward_all_destination\": null,\n \"forward_all_enabled\": null,\n \"forward_busy_destination\": null,\n \"forward_busy_enabled\": null,\n \"forward_no_answer_destination\": null,\n \"forward_no_answer_enabled\": null,\n \"forward_user_not_registered_destination\": null,\n \"forward_user_not_registered_enabled\": null,\n \"follow_me_uuid\": null,\n \"follow_me_enabled\": null,\n \"follow_me_destinations\": null,\n \"enabled\": \"true\",\n \"description\": null,\n \"absolute_codec_string\": null,\n \"force_ping\": null,\n \"insert_date\": \"2025-06-05 03:37:28.631375+00\",\n \"insert_user\": \"b56b7a27-264d-4a8d-ab31-e4df8a1923eb\",\n \"update_date\": null,\n \"update_user\": null\n },\n {\n \"extension_uuid\": \"9a30a19d-a2de-42c2-9fac-c626c98a5184\",\n \"domain_uuid\": \"325f7473-5973-4501-8450-75c5bfa824db\",\n \"extension\": \"790\",\n \"number_alias\": null,\n \"password\": \"PASSWORD\",\n \"accountcode\": \"DOMAIN\",\n \"effective_caller_id_name\": null,\n \"effective_caller_id_number\": null,\n \"outbound_caller_id_name\": null,\n \"outbound_caller_id_number\": null,\n \"emergency_caller_id_name\": null,\n \"emergency_caller_id_number\": null,\n \"directory_first_name\": null,\n \"directory_last_name\": null,\n \"directory_visible\": \"true\",\n \"directory_exten_visible\": \"true\",\n \"max_registrations\": null,\n \"limit_max\": \"5\",\n \"limit_destination\": \"!USER_BUSY\",\n \"missed_call_app\": null,\n \"missed_call_data\": null,\n \"user_context\": \"DOMAIN\",\n \"toll_allow\": null,\n \"call_timeout\": \"30\",\n \"call_group\": null,\n \"call_screen_enabled\": \"false\",\n \"user_record\": \"all\",\n \"hold_music\": null,\n \"auth_acl\": null,\n \"cidr\": null,\n \"sip_force_contact\": null,\n \"nibble_account\": null,\n \"sip_force_expires\": null,\n \"mwi_account\": null,\n \"sip_bypass_media\": null,\n \"unique_id\": null,\n \"dial_string\": null,\n \"dial_user\": null,\n \"dial_domain\": null,\n \"do_not_disturb\": null,\n \"forward_all_destination\": null,\n \"forward_all_enabled\": null,\n \"forward_busy_destination\": null,\n \"forward_busy_enabled\": null,\n \"forward_no_answer_destination\": null,\n \"forward_no_answer_enabled\": null,\n \"forward_user_not_registered_destination\": null,\n \"forward_user_not_registered_enabled\": null,\n \"follow_me_uuid\": null,\n \"follow_me_enabled\": null,\n \"follow_me_destinations\": null,\n \"enabled\": \"true\",\n \"description\": null,\n \"absolute_codec_string\": null,\n \"force_ping\": null,\n \"insert_date\": \"2025-06-05 03:40:33.769444+00\",\n \"insert_user\": \"b56b7a27-264d-4a8d-ab31-e4df8a1923eb\",\n \"update_date\": null,\n \"update_user\": null\n }\n]\n\nNotes
\n- \n
Ensure that the
\napiKeyis correctly formatted and corresponds to an existing user account to avoid receiving a 404 error. \nIf the API key is valid and exists, the response will provide relevant information about the API key.
\n \n
Search Extension By Number Extension
\nMethod: GET
URL: {{domain}}/app/api/extensions-search/api-key{{{apiKey}}}
Description
\nThis endpoint is used to get specified detail data extension by searching based on extension number.
\nRequest Parameters
\n- \n
\ndomain: The unique identifier for your company given cloudpbx server. This is received by request tosupport@barantum.comand our sales will contact you for the detail. \napiKey (path parameter): The unique identifier for the user's API key. This key is required to access the API and should be included in the URL. You will also get the API key after get the domain value.
\n \n
Response Structure
\nThe response will contain the following:
\n- \n
Status Code:
\n- \n
\n200- This indicates that the request API key is success. \n
\n404- This indicates that the requested API key was not found. \n
\nContent-Type:
\n- \n
application/json\n
\nResponse Body:
\n- \n
- A list extensions. \n
\nResponse Error:
\n- \n
\nmessage: A string that provides additional information about the status of the request.- \n
API not found.: Message indicate you should check if your API key is valid or not. Also make sure the key is inserted between{and}. \n
\n
\n
Example Response Success
\n[\n \"message\": 200,\n \"extensions\": 1002,\n \"uuid\": \"UUID\"\n]\n\nNotes
\n- \n
Ensure that the
\napiKeyis correctly formatted and corresponds to an existing user account to avoid receiving a 404 error. \nIf the API key is valid and exists, the response will provide relevant information about the API key.
\n \n
Delete Extension
\nThis endpoint is used to delete a specific extension. By sending a DELETE request to this endpoint, users can remove unused extension.
\nRequest Parameters
\n- \n
extension_uuid (string): The unique identifier for the extension from which the API key is to be deleted.
\n \napiKey (string): The API key that needs to be deleted.
\n \n
Response Structure
\nUpon successful deletion, the response will indicate the status of the operation. The expected response will typically include by this JSON.
\n{\n \"message\": \"OK\"\n}\nEnsure that you have the necessary permissions to delete the specified API key before making this request.
\n","urlObject":{"path":["app","api","extensions{{{extension_uuid}}}","api-key{{{apiKey}}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3707294-d84d-4808-900f-510cc3b5311e"},{"name":"Add New Extension","id":"00e90f93-8f40-4f9a-a508-c23af8a9b3b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"extension\": \"1000\",\r\n \"number_alias\": \"\",\r\n \"password\": \"PASSWORD\",\r\n \"accountcode\": \"DOMAIN\",\r\n \"effective_caller_id_name\": 1000,\r\n \"effective_caller_id_number\": 1000,\r\n \"outbound_caller_id_name\": 1000,\r\n \"outbound_caller_id_number\": 1000,\r\n \"emergency_caller_id_name\": null,\r\n \"emergency_caller_id_number\": null,\r\n \"directory_first_name\": null,\r\n \"directory_last_name\": null,\r\n \"directory_visible\": \"true\",\r\n \"directory_exten_visible\": \"true\",\r\n \"max_registrations\": null,\r\n \"limit_max\": 5,\r\n \"limit_destination\": \"!USER_BUSY\",\r\n \"missed_call_app\": null,\r\n \"missed_call_data\": null,\r\n \"user_context\": \"DOMAIN\",\r\n \"toll_allow\": null,\r\n \"call_timeout\": 30,\r\n \"call_group\": null,\r\n \"call_screen_enabled\": \"false\",\r\n \"user_record\": \"all\",\r\n \"hold_music\": null,\r\n \"auth_acl\": null,\r\n \"cidr\": null,\r\n \"sip_force_contact\": null,\r\n \"nibble_account\": null,\r\n \"sip_force_expires\": null,\r\n \"mwi_account\": null,\r\n \"sip_bypass_media\": null,\r\n \"unique_id\": null,\r\n \"dial_string\": null,\r\n \"dial_user\": null,\r\n \"dial_domain\": null,\r\n \"do_not_disturb\": null,\r\n \"forward_all_destination\": null,\r\n \"forward_all_enabled\": null,\r\n \"forward_busy_destination\": null,\r\n \"forward_busy_enabled\": null,\r\n \"forward_no_answer_destination\": null,\r\n \"forward_no_answer_enabled\": null,\r\n \"forward_user_not_registered_destination\": null,\r\n \"forward_user_not_registered_enabled\": null,\r\n \"follow_me_uuid\": null,\r\n \"follow_me_enabled\": null,\r\n \"follow_me_destinations\": null,\r\n \"enabled\": \"true\",\r\n \"description\": null,\r\n \"absolute_codec_string\": null,\r\n \"force_ping\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"{{domain}}/app/api/extensions/api-key{{{apiKey}}}","description":"Create or Update Extension
\nMethod
\nPOST
Endpoint
\n{{domain}}/app/api/extensions/api-key{{{apiKey}}}
Description
\nThis endpoint is used to create or update an extension in the application. It requires a JSON payload containing various parameters that define the extension's configuration.
\nRequest Parameters
\nThe following parameters should be included in the request body as a JSON object:
\n- \n
extension (string): The unique identifier for the extension.
\n \nnumber_alias (string or null): Alias for the number, if applicable.
\n \npassword (string): The password for the extension.
\n \naccountcode (string): The account code associated with the extension.
\n \neffective_caller_id_name (string or number): The name that will be displayed as the caller ID.
\n \neffective_caller_id_number (string or number): The number that will be displayed as the caller ID.
\n \noutbound_caller_id_name (string or number): The outbound caller ID name.
\n \noutbound_caller_id_number (string or number): The outbound caller ID number.
\n \nemergency_caller_id_name (string or null): Caller ID name for emergency calls.
\n \nemergency_caller_id_number (string or null): Caller ID number for emergency calls.
\n \ndirectory_first_name (string or null): First name for directory listing.
\n \ndirectory_last_name (string or null): Last name for directory listing.
\n \ndirectory_visible (string): Visibility status in the directory (e.g., \"true\" or \"false\").
\n \ndirectory_exten_visible (string): Visibility status of the extension in the directory (e.g., \"true\" or \"false\").
\n \nmax_registrations (string or null): Maximum number of registrations allowed.
\n \nlimit_max (number): Maximum number of concurrent calls.
\n \nlimit_destination (string): Destination to route calls when limits are reached.
\n \nmissed_call_app (string or null): Application to handle missed calls.
\n \nmissed_call_data (string or null): Additional data for missed calls.
\n \nuser_context (string): Context for the user.
\n \ntoll_allow (string or null): Toll allowance settings.
\n \ncall_timeout (number): Timeout duration for calls.
\n \ncall_group (string or null): Group for call handling.
\n \ncall_screen_enabled (string): Indicates if call screening is enabled (e.g., \"true\" or \"false\").
\n \nuser_record (string): Recording settings for the user (e.g., \"all\").
\n \nhold_music (string or null): Music played while on hold.
\n \nauth_acl (string or null): Access control list for authentication.
\n \ncidr (string or null): CIDR notation for IP access.
\n \nsip_force_contact (string or null): Force contact for SIP.
\n \nnibble_account (string or null): Nibble account settings.
\n \nsip_force_expires (string or null): Force expiration for SIP.
\n \nmwi_account (string or null): MWI account settings.
\n \nsip_bypass_media (string or null): Bypass media for SIP.
\n \nunique_id (string or null): Unique identifier for the request.
\n \ndial_string (string or null): Dial string configuration.
\n \ndial_user (string or null): User for dialing.
\n \ndial_domain (string or null): Domain for dialing.
\n \ndo_not_disturb (string or null): Do not disturb settings.
\n \nforward_all_destination (string or null): Destination for forwarding all calls.
\n \nforward_all_enabled (string or null): Status of forwarding all calls.
\n \nforward_busy_destination (string or null): Destination for forwarding busy calls.
\n \nforward_busy_enabled (string or null): Status of forwarding busy calls.
\n \nforward_no_answer_destination (string or null): Destination for forwarding no answer calls.
\n \nforward_no_answer_enabled (string or null): Status of forwarding no answer calls.
\n \nforward_user_not_registered_destination (string or null): Destination for forwarding when user is not registered.
\n \nforward_user_not_registered_enabled (string or null): Status of forwarding when user is not registered.
\n \nfollow_me_uuid (string or null): UUID for follow-me functionality.
\n \nfollow_me_enabled (string or null): Status of follow-me functionality.
\n \nfollow_me_destinations (string or null): Destinations for follow-me functionality.
\n \nenabled (string): Indicates if the extension is enabled (e.g., \"true\" or \"false\").
\n \ndescription (string or null): Description of the extension.
\n \nabsolute_codec_string (string or null): Codec settings.
\n \nforce_ping (string or null): Force ping settings.
\n \n
Expected Response Format
\nThe response will typically include a confirmation of the operation's success or failure, along with any relevant data regarding the created or updated extension. The exact structure of the response will depend on the implementation but will generally include status codes and messages indicating the outcome of the request.
\n{\n \"message\": \"OK\"\n}\n\nRetrieve Detailed Extension By Extension Uuid
\nThis endpoint allows users to retrieve a detailed specific extension identified by its unique UUID.
\nRequest Parameters
\n- \n
extension_uuid (string, required): The unique identifier for the extension whose API key is being requested.
\n \napiKey (string, required): The API key used for authentication to access this endpoint.
\n \n
Expected Response
\nUpon a successful request, the response will include details regarding the specified extension. The response will typically contain in this JSON response.
\n[\n {\n \"extension_uuid\": \"05f73de6-a623-4613-ab9f-8bf21674ef65\",\n \"domain_uuid\": \"325f7473-5973-4501-8450-75c5bfa824db\",\n \"extension\": \"789\",\n \"number_alias\": null,\n \"password\": \"PASSWORD\",\n \"accountcode\": \"DOMAIN\",\n \"effective_caller_id_name\": null,\n \"effective_caller_id_number\": null,\n \"outbound_caller_id_name\": null,\n \"outbound_caller_id_number\": null,\n \"emergency_caller_id_name\": null,\n \"emergency_caller_id_number\": null,\n \"directory_first_name\": null,\n \"directory_last_name\": null,\n \"directory_visible\": \"true\",\n \"directory_exten_visible\": \"true\",\n \"max_registrations\": null,\n \"limit_max\": \"5\",\n \"limit_destination\": \"!USER_BUSY\",\n \"missed_call_app\": null,\n \"missed_call_data\": null,\n \"user_context\": \"DOMAIN\",\n \"toll_allow\": null,\n \"call_timeout\": \"30\",\n \"call_group\": null,\n \"call_screen_enabled\": \"false\",\n \"user_record\": \"all\",\n \"hold_music\": null,\n \"auth_acl\": null,\n \"cidr\": null,\n \"sip_force_contact\": null,\n \"nibble_account\": null,\n \"sip_force_expires\": null,\n \"mwi_account\": null,\n \"sip_bypass_media\": null,\n \"unique_id\": null,\n \"dial_string\": null,\n \"dial_user\": null,\n \"dial_domain\": null,\n \"do_not_disturb\": null,\n \"forward_all_destination\": null,\n \"forward_all_enabled\": null,\n \"forward_busy_destination\": null,\n \"forward_busy_enabled\": null,\n \"forward_no_answer_destination\": null,\n \"forward_no_answer_enabled\": null,\n \"forward_user_not_registered_destination\": null,\n \"forward_user_not_registered_enabled\": null,\n \"follow_me_uuid\": null,\n \"follow_me_enabled\": null,\n \"follow_me_destinations\": null,\n \"enabled\": \"true\",\n \"description\": null,\n \"absolute_codec_string\": null,\n \"force_ping\": null,\n \"insert_date\": \"2025-06-05 03:37:28.631375+00\",\n \"insert_user\": \"b56b7a27-264d-4a8d-ab31-e4df8a1923eb\",\n \"update_date\": null,\n \"update_user\": null\n }\n]\n\nNotes
\n- \n
Ensure that the provided
\nextension_uuidandapiKeyare valid and correctly formatted. \nThis endpoint requires proper authentication; invalid or expired API keys will result in an error response.
\n \n
This folder provides a complete set of API endpoints to manage VoIP Extensions within the Call Center system.
\nIt supports full CRUD (Create, Read, Update, Delete) operations, as well as managing extension-user associations.
\n\n
📌 Key Functionalities
\n- \n
🔍 List Extensions: Retrieve a list of all registered extensions.
\n \n➕ Add Extension: Create a new extension with configuration options.
\n \n🖊️ Update Extension: Modify an existing extension.
\n \n❌ Delete Extension: Remove an unused or deactivated extension.
\n \n📄 View Details: Get detailed information on a specific extension.
\n \n
\n
📘 Note
\n- \n
All requests must include a valid API key in the URL using the format
\napi-key{{apiKey}}. \nMake sure the extension number registered under the domain.
\n \n
Click to Call API
\nThis endpoint allows users to initiate a click-to-call action by sending a POST request. The request requires an API key for authentication and includes the following parameters in the request body:
\n- \n
extention (string): The extension number to which the call will be directed.
\n \nnumber (string): The extension or phone number that will be called.
\n \n
Upon successful execution, the API returns a status code of 200 along with a JSON response containing a message object. The response includes a message field and a uuid field, which can be used for tracking or further processing of the call.
Request Example
\n{\n \"extention\": \"EXTENSION_NUMBER\",\n \"number\": \"DESTINATION_NUMBER\"\n}\n\nResponse Example
\n{\n \"message\": {\n \"message\": \"OK\",\n \"uuid\": \"UUID\"\n }\n}\n\nThis API is useful for integrating click-to-call functionality into applications, facilitating seamless communication directly from the user interface.
\n","urlObject":{"path":["app","api","click_to_call","api-key{{{apiKey}}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"150c9ac1-41ed-46ef-a2d8-f599ee17d253"}],"id":"d2c12041-5455-4f34-a6c8-466b742442ee","description":"This folder provides an endpoint to initiate outbound phone calls through a call center system using a simple HTTP POST request. It is designed for systems that require click-to-call integration, enabling agents or users to trigger calls directly from a web interface or internal dashboard.
\n\n
✅ Purpose
\nEnable seamless interaction by initiating a phone call from a specified call center extension to a target number (such as a customer's phone number).
\n\n
🧩 Use Cases
\n- \n
CRM tools initiating calls to customers
\n \nHelpdesk agents connecting with clients via a single click
\n \nAutomating outbound calls from dashboards or internal portals
\n \n
\n
📘 Note
\n- \n
All requests must include a valid API key in the URL using the format
\napi-key{{apiKey}}. \nMake sure the extension number registered under the domain.
\n \n
Retrieve Call Detail Records (CDR)
\nThis endpoint allows you to retrieve Call Detail Records (CDR) based on specified criteria such as time range and pagination settings. The request is made using the HTTP POST method.
\nRequest Format
\n- \n
URL:
\n{{domain}}/app/api/cdr/api-key{{{apiKey}}}\nMethod: POST
\n \nContent-Type: application/json
\n \n
Request Body
\nThe request body must be a JSON object with the following parameters:
\n- \n
page (integer): The page number of the results to retrieve. This is used for pagination.
\n \nlimit (integer): The maximum number of records to return per page.
\n \nstart_stamp_begin (string): The start timestamp for filtering records, formatted as \"YYYY-MM-DD HH:MM\" (optional).
\n \nstart_stamp_end (string): The end timestamp for filtering records, formatted as \"YYYY-MM-DD HH:MM\" (optional).
\n \n
Example Request Body:
\n{\n \"page\": 1,\n \"limit\": 15,\n \"start_stamp_begin\": \"2025-06-20 08:45\",\n \"start_stamp_end\": \"2025-06-20 09:15\"\n}\n\nResponse Structure
\nThe response will contain a JSON object with the details of the retrieved Call Detail Records based on the specified parameters. The structure of the response will include in message object with:
\n- \n
limit (integer): The maximum data shown.
\n \npage (integer): Current page accessed.
\n \ndata (array): An array of CDR objects, each containing details such as call duration, caller ID, receiver ID, and timestamps.
\n \n
{\n \"message\": {\n \"limit\": 15,\n \"page\": 1,\n \"data\": [...]\n }\n}\n\nThis endpoint is essential for applications that need to analyze call data within a specified timeframe, facilitating effective data management and reporting.
\n","urlObject":{"path":["app","api","cdr","api-key{{{apiKey}}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"05a890f1-7853-43eb-a72c-9450b88b79f4"}],"id":"6d87fc94-910c-4223-bcb1-7ad2b33b210f","description":"📈 Report Folder
\nThe Report folder contains endpoints designed for retrieving analytical and historical data related to your call center operations. These APIs allow external systems, administrators, or dashboards to query Call Detail Records (CDRs) based on time filters, pagination, and other parameters.
\n\n
🔍 Key Functionalities
\n- \n
- Fetch call history logs using flexible time-based filters \n
- Support for pagination to manage large datasets \n
- Integration-ready format for dashboards, reports, and audits \n
- Enables data-driven insights for agent performance and system usage \n
\n
📘 Common Use Cases
\n- \n
- Viewing inbound and outbound call activity \n
- Generating performance or billing reports \n
- Building internal analytics dashboards \n
- Performing audits or regulatory compliance checks \n
\n
🔐 Access Requirements
\nAll endpoints in this folder require:
\n- \n
- A valid
{{apiKey}}as part of the URL \n - Proper formatting of timestamps (e.g.,
YYYY-MM-DD HH:MM) \n - JSON-formatted request bodies for POST endpoints \n
\n
\n\n","_postman_id":"6d87fc94-910c-4223-bcb1-7ad2b33b210f"}],"id":"df593279-cc3a-42b1-9ca7-5e6e4ec859f0","description":"⚠️ Note: Always validate timestamp inputs and handle pagination to ensure accurate data retrieval in large-scale systems.
\n
This collection provides a complete set of RESTful APIs to manage the Call Center's extension system.
\nIt is designed for system integrators or developers who need to programmatically interact with Barantum's CloudPBX services.
\n\n
🛡️ Authentication
\nAll endpoints require an API key (apiKey) and a domain (domain) as part of the URL path. These credentials are provided upon request:
- \n
Request via:
\nsupport@barantum.com\nOnce approved, you will receive:
\n- \n
Your domain URL
\n \nThe associated
\napiKey\n
\n
Authentication is passed as a path parameter in the format:
\n{{domain}}/app/api/.../api-key{{apiKey}}\n\n\n
📦 Modules Covered
\n- \n
📁 Extensions
\n- \n
Create, read, update, and delete extensions
\n \nRetrieve detailed extension data
\n \n
\n📁 Click To Call
\n- \n
- Initiating click to call from agent to specified phone number \n
\n📁 Report
\n- \n
- Summarized report telephony \n
\n
\n
📘 Tip: Use the Postman environment variables ({{domain}}, {{apiKey}}, {{extension_uuid}}) to streamline testing.
For support or integration guidance, contact Barantum Support.
\n","_postman_id":"df593279-cc3a-42b1-9ca7-5e6e4ec859f0"}]}