This public collection contains common queries, sample responses, and links to supporting documentation for the Voximplant Kit API.
\nAll API methods support the application/x-www-form-urlencoded format. If required, upload a file to the server in the multipart/form-data format.
\nThe preferred way of using the Voximplant Kit API is as follows:
\nGenerate an API token in the Administration > Security > API tokens section in Voximplant Kit.
\nPaste the generated API token into the access_token parameter in a request body or URL (YOUR_ACCESS_TOKEN).
\nCopy your Account name in the Administration > Security > API tokens section in Voximplant Kit.
\nPaste the Account name into the domain parameter in a request or URL (YOUR_ACCOUNT_NAME).
\nCopy your API hostname in the Administration > Security > API tokens section in Voximplant Kit.
\nPaste your API hostname into a request URL (YOUR_ACCOUNT_API_HOST).
\nYOUR_ACCOUNT_CTI_API_HOST is kit-cti-region.voximplant.com, where the region is your account region in lowercase (us, br, eu, kz, ru, ru2).
\nYOUR_ACCOUNT_MESSAGING_API_HOST is kit-im-region.voximplant.com, where the region is your account region in lowercase (us, br, eu, kz, ru, ru2).
\nA completion code indicates the result of a call attempt. Voximplant Kit returns completion codes in callbacks and API responses that contain call attempt information.
\nThe listed values refer to the completion_code field.
\nInbound call scenario:
\nOutbound call scenario / automated campaign:
\nOutbound call from softphone:
\nPDS campaign:
\nAutomatic callbacks:
\nSome completion codes correspond to CallFailed codes:
\nThe most common response status codes are as follows:
\n200 - Ok. The request succeeded.
\n400, 422 - Bad or unprocessable request. The server cannot process the request due to client or semantic errors.
\n401 - Unauthorized request. The client must authenticate itself to get the requested response.
\n402 - Payment is required. Some API requests may be chargeable.
\n403 - Forbidden. The client does not have access rights to the content.
\n404 - Not found. The server cannot find the requested resource (for example, a non-existent queue ID in queue update requests).
\n429 - Too many requests. Users cannot send too many requests in a given amount of time (rate limit).
\n5XX - Voximplant Kit server error.
\nIf a response status is not Ok (200), its body contains an error code with a detailed description.
\nExample:
\n{\n \"success\": false,\n \"result\": {\n \"error\": \"You are not allowed to perform this action.\",\n \"code\": 403\n }\n}\n\nString. Required.
\nYour API token.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/account/getAccountInfo?domain={{domain}}","description":"Gets the information about the current account, such as the account name, currency, etc.
\n","urlObject":{"protocol":"https","path":["api","v3","account","getAccountInfo"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"28aac2cc-42bd-40ac-ad23-4fc21d4c0de0","name":"getAccountInfo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/account/getAccountInfo?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","account","getAccountInfo"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 11 Aug 2023 08:35:53 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c510763bc81e55a26faac9ea3eb75baa"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"domain\": {\n // your account id\n \"id\": 169,\n \"name\": \"Your account name\",\n \"balance\": 1621.28,\n \"credit\": 0,\n \"currency\": \"EUR\",\n \"max_lines_count\": 50,\n \"partner\": {\n \"name\": \"smartcalls\",\n \"theme\": null,\n \"blocks\": \"{}\",\n \"default_balance\": \"100\",\n \"default_currency\": \"EUR\",\n \"media_servers_regions\": [\n \"europe\"\n ]\n },\n \"tariff\": {\n \"id\": 66\n },\n \"can_change_tariff\": true,\n \"cc_settings\": {\n \"can_inbound_calls\": true,\n \"can_outbound_calls\": true,\n \"outbound_phone_id\": null,\n \"outbound_caller_id\": null,\n \"card_load_type\": \"url\",\n \"card_load_url\": \"https://card-load.exp\",\n \"card_load_function_id\": null,\n \"card_load_enabled\": false,\n \"can_internal_calls\": true,\n \"outbound_record_notification_type\": \"none\",\n \"tts_language\": null,\n \"tts_voice\": null,\n \"tts_text\": null,\n \"can_outbound_record\": false,\n \"media_id\": null,\n \"can_change_caller_id\": false,\n \"can_hold_record\": true,\n \"hold_media_id\": 301,\n \"outbound_record_notification_duration\": \"DEFAULT\",\n \"agent_dialing_max_waiting_time_sec\": 15,\n \"agent_dialing_media_enabled\": false,\n \"agent_dialing_media_id\": null,\n \"group_dialing_media_enabled\": false,\n \"group_dialing_media_id\": null,\n \"queue_dialing_media_enabled\": false,\n \"queue_dialing_media_id\": null,\n \"outbound_sip_number_id\": 211,\n \"can_internal_record\": false,\n \"hold_notification_enabled\": true,\n \"hold_notification_time_sec\": 30,\n \"internal_record_storage_duration\": \"DEFAULT\",\n \"can_agent_access_calls_recordings\": false\n },\n \"cc_enabled\": true,\n \"cc_enabled_date\": \"2021-11-01 08:06:51\",\n \"cc_demo_mode\": false,\n \"function_enabled\": false,\n \"max_users\": 250,\n \"max_trial_users\": 250,\n \"need_reg_form\": true,\n \"reg_form_completed\": true,\n \"agent_campaigns_enabled\": true,\n \"can_sip_refer\": false,\n \"enable_2fa\": false,\n \"max_attachments_in_storage\": 100,\n \"attachments_on_account\": 0,\n \"application_id\": 10162980,\n \"account_id\": 4178877,\n \"internal_chat_enabled\": true,\n \"blending_enabled\": false,\n \"media_servers_regions\": null,\n \"max_queues\": 20,\n \"account_region\": \"EU\"\n }\n }\n}"}],"_postman_id":"5f4a1421-6b74-47b8-b48f-cac169cacf13"}],"id":"b09694bd-7a1c-457f-bea0-28f64c39002d","description":"This folder contains actions you may need to get the information about the current account.
\n","_postman_id":"b09694bd-7a1c-457f-bea0-28f64c39002d"},{"name":"agentCampaigns","item":[{"name":"createCampaign","id":"bc791147-69df-4566-9b7a-52abee782937","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"Test PDS campaign","type":"text","description":"String. Required.
\nThe campaign name. The maximum name length is 255 characters.
\n"},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional.
\nThe campaign folder ID.
\nYou can store your campaigns in folders or in the root directory (default).
\n","disabled":true},{"key":"phone_number_id","value":"268","type":"text","description":"Integer. Required if the 'caller_id' and 'sip_number_id' parameters are empty.
\nThe identifier of the phone number to use for the campaign's outbound calls. This is the ID of the phone number you purchased in Voximplant Kit.\nUse the searchNumbers method to retrieve available phone numbers.
\n"},{"key":"caller_id","value":"","type":"text","description":"Integer. Required if the 'phone_number_id' and 'sip_number_id' parameters are empty.
\nThe identifier of the Caller ID to use for the campaign's outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"sip_number_id","value":"","type":"text","description":"Integer. Required if caller_id and phone_number_id are empty.
\nThe identifier of the external number to use for the campaigns' outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.
\n","disabled":true},{"key":"phone_numbers","value":"{\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]}","description":"JSON array. Required if 'caller_id', 'phone_number_id', and 'sip_number_id' parameters are empty.
\nIdentifiers of phone numbers to be used as campaign Caller IDs. The system will rotate the added Caller IDs and randomly pick one for each outbound call. The maximum number of Caller IDs is 100.
\nThe numbers you indicate must be active. You cannot specify phone_number_ids and/or caller_id_ids together with sip_number_ids in one array. Phone_number_ids and caller_id_ids together are allowed.
\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}
\n","type":"text","disabled":true},{"key":"date_start","value":"2022-02-20 08:00:00","type":"text","description":"String. Optional.
\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign. The supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"date_end","value":"2022-02-22 17:00:00","type":"text","description":"String. Optional.
\nThe date and time when the campaign should stop calling customers. The supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"max_attempts","value":"3","type":"text","description":"Integer. Optional.
\nThe maximum number of attempts to dial each customer within the campaign. If the campaign fails to reach a customer withthin the specified number of attempts, this customer is labelled 'unsuccessful' in the campaign statistics. The options are 1, 2, 3, 4, 5. The default value is 1.
\n"},{"key":"interval","value":"","type":"text","description":"Integer. Optional.
\nThe interval (in minutes) between dialing attempts to each customer within the campaign. The default value is 60 minutes.
\n","disabled":true},{"key":"working_time","value":"","type":"text","description":"Array. Optional.
\nThe time when the campaign calls customers. The system uses customers’ local time. The pattern is [\"12:00:00\", \"16:00:00\"]. The default value is [\"\", \"\"].
\nIMPORTANT! The local time is calculated based on the {{UTC}} parameter in the contact list file. If you do not specify the campaign working hours, Voximplant Kit calls customers 24/7.
\n","disabled":true},{"key":"user_ids","value":"[2517]","type":"text","description":"Integer array. Optional.
\nIDs of the users you want to add to the campaign. Use the searchUsers method to retrieve the list of user ids.
\n","disabled":true},{"key":"operator_priority_strategy","value":"","type":"text","description":"String. Optional.
\nThe campaign call distribution strategy based on agent priority. The options are MOST_QUALIFIED|LEAST_QUALIFIED|MAX_WAITING_TIME. The default value is MAX_WAITING_TIME.
\nString. Optional.
\nThe campaign call distribution strategy based on request priority. The options are MAX_PRIORITY|MAX_WAITING_TIME. The default value is MAX_PRIORITY.
\nBoolean. Optional.
\nSpecifies whether the voicemail detection feature is enabled for the campaign. The default setting is false.
\n","disabled":true},{"key":"voicemail_detection_model","value":"br","description":"String. Required if voicemail_detection_enabled is true.
\nThe voicemail detection model to use in the campaign. \nThe options are 'ru' | 'kz' | 'colombia' | 'br' | 'mx' | 'ph' | 'pe' | 'us' | 'cl' | 'ru_experimental_vm' | 'ru_experimental_human'.
\n","type":"text","disabled":true},{"key":"voicemail_detection_timeout_sec","value":"2","description":"Float. Required if voicemail_detection_enabled is true.
\nThe maximum detection time. Minimum = 1, max = 10.
\n","type":"text","disabled":true},{"key":"voicemail_detection_timeout_continue_call","value":"true","description":"Boolean. Optional.
\nSpecifies how the system should behave if it fails to detect whether it reached a live person or voicemail.
\nIf set to \"true\", the call is routed to a campaign agent. \nIf set to \"false\", the call is terminated.
\n","type":"text","uuid":"0d2dc7a7-e703-4f03-a27e-1e4438dff9bb","disabled":true},{"key":"dial_up_time_sec","value":"","type":"text","description":"Integer. Optional.
\nThe amount of time (in seconds) an agent dials a customer before moving on to the next one.
\n","disabled":true},{"key":"afterservice_time_limit_enabled","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the after service time limit is enabled for the campaign. When enabled, the campaign agents have limited time to spend on post-call activities, like making call records, adding contacts, or assigning wrap-up codes. The default setting is false.
\n","disabled":true},{"key":"afterservice_time_limit","value":"","type":"text","description":"Integer. Optional.
\nThe maximum time the campaign agents can spend on post-call activities (after service). The default value is 0.
\n","disabled":true},{"key":"can_outbound_record","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether outbound call recording is enabled for the campaign. When enabled, the system records all outbound calls and stores the recordings in the Call history section, so that you could listen and download them. The default setting is false.
\nIMPORTANT! In some countries, you are compelled by law to inform the other party that you are recording the call.
\n","disabled":true},{"key":"outbound_record_notification_type","value":"","type":"text","description":"String. Optional.
\nThe notification type used to inform a customer that the call is being recorded. The options are none|media|tts. The default value is none.
\n","disabled":true},{"key":"outbound_record_notification_duration","value":"","type":"text","description":"String. Optional.
\nThe time during which outbound call recordings are available for listening and downloading in the Call history sections. The options are DEFAULT|SIXMONTHS|ONEYEAR|TWOYEARS|THREEYEARS.
\n","disabled":true},{"key":"tts_language","value":"","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech language for outbound call recording notifications.
\nThe following languages are available:\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft.
\n","disabled":true},{"key":"tts_voice","value":"","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech voice for outbound call recording notifications.
\nThe following options are available:
\nBengali (India):
\nEnglish (US):
\nEnglish (GB):
\nEnglish (AU):
\nEnglish (IN):
\nRussian:
\nGerman:
\nFrench:
\nFrench (CA):
\nItalian:
\nJapanese:
\nDutch:
\nTurkish:
\nKorean:
\nSwedish:
\nDanish:
\nSlovak:
\nPortuguese (BR):
\nPortuguese (PT):
\nPolish:
\nUkrainian:
\nVietnamese:
\nFilipino:
\nArabic:
\nChinese (Mandarin):
\nCzech:
\nGreek:
\nFinnish:
\nHindi:
\nHungarian:
\nIndonesian:
\nNorwegian:
\nSpanish (Castilian):
\nSpanish (US):
\nKazakh (Kazakhstan):
\nSpanish (MX):
\nArabic (SA):
\nWelsh (UK):
\nIcelandic:
\nRomanian:
\nArabic:
\nChinese (Mandarin):
\nSpanish (LA):
\nAfrikaans (South Africa):
\nAmharic (Ethiopia):
\nArabic (Algeria):
\nArabic (Bahrein):
\nArabic (Egypt):
\nArabic (Iraq):
\nArabic (Jordan):
\nArabic (Kuwait):
\nArabic (Libya):
\nArabic (Morocco):
\nArabic (Qatar):
\nArabic (Syria):
\nArabic (Tunisia):
\nArabic (UAE):
\nArabic (Yemen):
\nAzerbaijani (Azerbaijan):
\nBangla (Bangladesh):
\nBulgarian:
\nBurmese (Myanmar):
\nCatalan (Spain):
\nChinese (Cantonese, Traditional):
\nChinese (Taiwanese Mandarin):
\nCroatian:
\nDutch (BE):
\nSpanish (Argentina):
\nNepali (Nepal):
\nEnglish (Canada):
\nEnglish (Hongkong):
\nEnglish (Ireland):
\nEnglish (Kenya):
\nEnglish (New Zeland):
\nEnglish (Nigeria):
\nEnglish (Philippines):
\nEnglish (South Africa):
\nEnglish (Tanzania):
\nFrench (Belgium):
\nFrench (Switzerland):
\nGalician (Spain):
\nGerman (Austria):
\nGerman (Switzerland):
\nGujarati (India):
\nIrish (Ireland):
\nJavanese (Indonesia):
\nKannada (India):
\nKazakh (Kazakhstan):
\nKhmer (Cambodia):
\nLao (Laos):
\nLithuanian (Lithuania):
\nMacedonian (North Macedonia):
\nMalay:
\nMalayalam (India):
\nMaltese (Malta):
\nMarathi (India):
\nPashto (Afghanistan):
\nPersian (Iran):
\nSerbian (Serbia, Cyrillic):
\nSinhala (Sri Lanka):
\nSlovenian:
\nSomali (Somalia):
\nSpanish (Bolivia):
\nSpanish (Chile):
\nSpanish (Costa Rica):
\nSpanish (Cuba):
\nSpanish (Dominican Republic):
\nSpanish (Ecuador):
\nSpanish (El Salvador):
\nSpanish (Equatorial Guinea):
\nSpanish (Guatemala):
\nSpanish (Honduras):
\nSpanish (Nicaragua):
\nSpanish (Panama):
\nSpanish (Paraguay):
\nSpanish (Peru):
\nSpanish (Puerto Rico):
\nSpanish (Uruguay):
\nSpanish (Venezuela):
\nSundanese (Indonesia):
\nSwahili (Tanzania):
\nTamil (India):
\nTamil (Singapore):
\nTamil (Sri Lanka):
\nTelugu (India):
\nThai:
\nUrdu (India):
\nUrdu (Pakistan):
\nZulu (South Africa):
\nUzbek:
\nHebrew: (Israel):
\nSpanish (Colombia):
\nEstonian (Estonia):
\nLatvian (Latvia):
\nString. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech text for outbound call recording notifications.
\n","disabled":true},{"key":"media_id","value":"","type":"text","description":"Integer. Required if can_outbound_record is selected and outbound_record_notification_type is media.
\nThe ID of the media file uploaded for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"client_waiting_media_id","value":"","description":"Integer. Optional.
\nThe ID of the media file that will be played to a customer while waiting for an agent. Use the searchMedia method to retrieve the list of available media files.
\n","type":"text","disabled":true},{"key":"call_auto_answer","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the auto-answer calls feature is enabled for the campaign. When an inbound call comes in, the system automatically connects a customer to an agent. The default setting is false.
\n","disabled":true},{"key":"agents_can_decline_calls","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the campaign agents can decline external calls. The default setting is true.
\n","disabled":true},{"key":"region_enabled","value":"true","type":"text","description":"Boolean. Optional.\nSpecifies whether the region to launch campaign calls is specified.
\n","disabled":true},{"key":"region","value":"europe","type":"text","description":"String. Required if the \"region_enabled\" flag is true. \nThe options are usa | europe | south_america | singapore | russia | kazakhstan.
\n","disabled":true},{"key":"mode","value":"","type":"text","description":"String. Optional.
\nThe campaign mode: predictive or progressive. The default setting is predictive.
\nIn the predictive mode, the campaign uses an algorithm to make predictions about agent availability and places calls based on the output of the algorithm. This algorithm uses such inputs as the number of agents, average handle time, successful/failed calls ratio, etc.
\nIn the progressive mode, the campaign places calls to agents based on the number of agents available, i.e. it dials one contact for each available agent.
\n","disabled":true},{"key":"wrap_up_codes_set_id","value":"","type":"text","description":"Integer. Optional.
\nThe wrap-up codes set ID.
\nYou assign a wrap-up codes set to your campaign if you want the campaign agents to label the outcome of their calls after interaction with a customer. The default value is null.
\n","disabled":true},{"key":"wrap_up_dnc_list_id","value":"","type":"text","description":"Integer. Optional.
\nThe Do not call (DNC) list ID.
\nIf the wrap-up codes set you attached to the campaign contains the Add to DNC list code, the system prompts you to bind a DNC list. The default value is null.
\n","disabled":true},{"key":"dnc_lists","value":"","type":"text","description":"Integer array. Optional.
\nThe DNC list ID(s) you want to bind to the campaign. The contacts put on those lists do not receive calls within the campaign. Use the searchDncList method to retrieve the list of DNC list IDs.
\n","disabled":true},{"key":"task_multiplier","value":"","type":"text","description":"Float. Optional.
\nThe campaign workload distribution factor. The parameter applies to progressive PDS campaigns only. It determines the pace of placing calls to each idle agent. The minimum value is 1.0, maximum - 25.0. For campaigns with more than 20 agents, the limit is 100.
\n","disabled":true},{"key":"abandonment_rate","value":"","type":"text","description":"Integer. Optional.
\nThe campaign abandon rate parameter. Applies to predictive PDS campaigns only. It determines the pace of placing calls by adjusting the percentage of abandoned calls. The minimum value is 1, maximum - 100, default - 3.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/agentCampaigns/createCampaign?domain={{domain}}","description":"Creates a PDS campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","createCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"b45a8542-2a4b-40c9-bd32-c7a8a8ad4ff7","name":"createCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"title","value":"Test PDS campaign","type":"text"},{"key":"folder_id","value":"","type":"text","disabled":true},{"key":"phone_number_id","value":"268","type":"text"},{"key":"caller_id","value":"50","type":"text","disabled":true},{"key":"date_start","value":"2022-02-20 08:00:00","type":"text","disabled":true},{"key":"date_end","value":"2022-02-22 17:00:00","type":"text","disabled":true},{"key":"max_attempts","value":"","type":"text","disabled":true},{"key":"interval","value":"","type":"text","disabled":true},{"key":"working_time","value":"","type":"text","disabled":true},{"key":"user_ids","value":"[2517]","type":"text","disabled":true},{"key":"operator_priority_strategy","value":"","type":"text","disabled":true},{"key":"request_priority_strategy","value":"","type":"text","disabled":true},{"key":"voicemail_detection_enabled","value":"","type":"text","disabled":true},{"key":"dial_up_time_sec","value":"","type":"text","disabled":true},{"key":"afterservice_time_limit_enabled","value":"","type":"text","disabled":true},{"key":"afterservice_time_limit","value":"","type":"text","disabled":true},{"key":"can_outbound_record","value":"","type":"text","disabled":true},{"key":"outbound_record_notification_type","value":"","type":"text","disabled":true},{"key":"outbound_record_notification_duration","value":"","type":"text","disabled":true},{"key":"tts_language","value":"","type":"text","disabled":true},{"key":"tts_voice","value":"","type":"text","disabled":true},{"key":"tts_text","value":"","type":"text","disabled":true},{"key":"media_id","value":"","type":"text","disabled":true},{"key":"call_auto_answer","value":"","type":"text","disabled":true},{"key":"agents_can_decline_calls","value":"","type":"text","disabled":true},{"key":"mode","value":"","type":"text","disabled":true},{"key":"wrap_up_codes_set_id","value":"34","type":"text","disabled":true},{"key":"wrap_up_dnc_list_id","value":"11","type":"text","disabled":true},{"key":"dnc_lists","value":"[17, 12, 10,11]","type":"text","disabled":true},{"key":"task_multiplier","value":"1.0","type":"text","disabled":true},{"key":"abandonment_rate","value":"3","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/createCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","createCampaign"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 10 Mar 2023 10:12:03 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"a606f32d7c62a7c1eef42800d513c40c"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 2366,\n \"title\": \"Test PDS campaign\",\n \"status\": \"draft\",\n \"mode\": \"predictive\",\n \"folder_id\": null,\n \"date_start\": null,\n \"date_end\": null,\n \"working_time\": [\n \"\",\n \"\"\n ],\n \"max_attempts\": 1,\n \"interval\": 0,\n \"phone_number_id\": 268,\n \"caller_id\": null,\n \"settings\": {\n \"voicemail_detection_enabled\": false,\n \"dial_up_time_sec\": 40,\n \"outbound_call_recording\": {\n \"enabled\": false,\n \"notification\": {\n \"type\": \"none\",\n \"tts_text\": null,\n \"tts_voice\": null,\n \"tts_language\": null,\n \"media_id\": null\n },\n \"storage_period\": \"DEFAULT\"\n }\n },\n \"create_date\": \"2023-03-10 10:12:03\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null,\n \"queue\": {\n \"id\": 3403,\n \"title\": \"Test PDS campaign\",\n \"operator_priority_strategy\": \"MAX_WAITING_TIME\",\n \"request_priority_strategy\": \"MAX_PRIORITY\",\n \"afterservice_time_limit_enabled\": false,\n \"afterservice_time_limit\": 0,\n \"agents_can_end_calls\": true,\n \"agents_can_decline_calls\": true\n },\n \"timezone\": \"UTC\",\n \"sip_number_id\": null,\n \"use_tags\": true,\n \"use_topics\": false,\n \"topic_set_id\": null,\n \"task_multiplier\": 1,\n \"abandonment_rate\": 3,\n \"reference_ip\": null\n }\n}"}],"_postman_id":"bc791147-69df-4566-9b7a-52abee782937"},{"name":"deleteCampaign","id":"adc62844-1bc0-46b9-8375-56a3b0612973","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"2366","type":"text","description":"Integer. Required.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n"}]},"url":"https://{{host}}/api/v3/agentCampaigns/deleteCampaign?domain={{domain}}","description":"Deletes a PDS campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","deleteCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"67350906-6a5b-4744-a424-12116349756c","name":"deleteCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"2366","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/deleteCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","deleteCampaign"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 10 Mar 2023 11:33:50 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"5fa9c429b31ca7dc4ae34cf650f69352"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"adc62844-1bc0-46b9-8375-56a3b0612973"},{"name":"searchCampaigns","id":"4af318b2-48fd-4367-a034-a05d639abfca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1464","type":"text","description":"Integer. Optional.
\nThe particular campaign ID(s) to filter.
\n"},{"key":"title","value":"","type":"text","description":"String. Optional.
\nThe particular campaign name to filter.
\n","disabled":true},{"key":"status","value":"","type":"text","description":"Array. Optional.
\nCampaign status(es). The supported campaign statuses are draft, ongoing, paused, completed, scheduled. Example: [\"draft\", \"ongoing\"].
\n","disabled":true},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional.
\nThe particular campaign folder ID.
\n","disabled":true},{"key":"with_queue","value":"true","type":"text","description":"Boolean or integer. Optional.
\nSpecifies whether the report should include queue information. The options are true|false|0|1. The default setting is false.
\n"},{"key":"with_campaign_lists","value":"","type":"text","description":"Boolean or integer. Optional.
\nSpecifies whether the report should include the attached contact lists. The options are true|false|0|1. The default setting is false.
\n","disabled":true},{"key":"with_users","value":"true","type":"text","description":"Boolean or integer. Optional.
\nSpecifies whether the report should include users. The options are true|false|0|1. The default setting is false.
\n"},{"key":"with_folder_name","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include the campaign folder name.
\n","disabled":true},{"key":"with_wrap_up_codes_set","value":"true","type":"text","description":"Boolean or integer. Optional.
\nSpecifies whether the report should include the assigned wrap-up codes sets. The options are true|false|0|1. The default setting is false.
\n"},{"key":"with_dnc_lists","value":"true","type":"text","description":"Boolean or integer. Optional.
\nSpecifies whether the report includes the attached DNC lists. he options are true|false|0|1. The default setting is false.
\n"},{"key":"task_multiplier","value":"","type":"text","description":"Float. Optional.
\nThe campaign workload distribution factor. The setting determines the pace of placing calls to each idle agent. The minimum value is 1.0, maximum - 5.0.
\n","disabled":true},{"key":"abandonment_rate","value":"","type":"text","description":"Integer. Optional.
\nThe campaign abandon rate parameter. The setting determines the pace of placing calls by adjusting the percentage of abandoned calls. The minimum value is 1, maximum - 100.
\n","disabled":true},{"key":"with_supervisors","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include supervisors.\nThe default setting is false.
\n","disabled":true},{"key":"with_phone_numbers","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include phone numbers used as campaign Caller IDs.
\n","type":"text","disabled":true},{"key":"page","value":"13","description":"Integer. Optional.
\nThe particular page number to include in the report.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/agentCampaigns/searchCampaigns?domain={{domain}}&sort=-id&per-page=50","description":"Retrieves a list of PDS campaigns.
\nIf you define specific query parameters, the request retrieves only the PDS campaigns that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","searchCampaigns"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-id"},{"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"50"}],"variable":[]}},"response":[{"id":"94fde005-b4ca-483d-82b4-4ebb1daf0d12","name":"searchCampaigns","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"YOUR_ACCESS_TOKEN","type":"text"},{"key":"id","value":"1464","type":"text"},{"key":"title","value":"","type":"text","disabled":true},{"key":"status","value":"","type":"text","disabled":true},{"key":"folder_id","value":"","type":"text","disabled":true},{"key":"with_queue","value":"true","type":"text"},{"key":"with_campaign_lists","value":"true","type":"text","disabled":true},{"key":"with_users","value":"true","type":"text","disabled":true},{"key":"per-page","value":"50","type":"text"},{"key":"with_folder_name","value":"1","type":"text","disabled":true},{"key":"with_wrap_up_codes_set","value":"true","type":"text"},{"key":"with_dnc_lists","value":"true","type":"text"},{"key":"task_multiplier","value":"","type":"text","disabled":true},{"key":"abandonment_rate","value":"","type":"text","disabled":true},{"key":"page","value":"13","description":"Integer. Optional.\n\nThe particular page number to include in the report.","type":"text","disabled":true}]},"url":{"raw":"https://YOUR_ACCOUNT_API_DOMAIN/api/v3/agentCampaigns/searchCampaigns?domain=YOUR_ACCOUNT_NAME&sort=-id","protocol":"https","host":["YOUR_ACCOUNT_API_DOMAIN"],"path":["api","v3","agentCampaigns","searchCampaigns"],"query":[{"key":"domain","value":"YOUR_ACCOUNT_NAME","description":"Your account name."},{"key":"sort","value":"-id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 20 Mar 2023 14:53:28 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c77a435722165b417446009b625f9261"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"50"},{"key":"Link","value":"String. Required.
\nYour API token.
\n","type":"text"},{"key":"title","value":"Test PDS campaign","type":"text","description":"String. Required.
\nThe campaign name.
\n"},{"key":"caller_id","value":"","type":"text","description":"String. Optional.
\nThe identifier of the Caller ID used for the campaign's outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"sip_number_id","value":"","type":"text","description":"Integer. Optional.
\nThe identifier of the external number used for the campaigns' outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.
\n","disabled":true},{"key":"phone_numbers","value":"{\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]}","description":"JSON array. Optional.
\nIdentifiers of the phone numbers used as campaign Caller IDs. The maximum number of Caller IDs is 100.
\nYou cannot specify phone_number_ids and/or caller_id_ids together with sip_number_ids in one array. Phone_number_ids and caller_id_ids together are allowed.
\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}
\n","type":"text","disabled":true},{"key":"max_attempts","value":"3","type":"text","description":"Integer. Optional.
\nThe maximum number of attempts to dial each customer within the campaign. If the campaign fails to reach a customer withthin the specified number of attempts, this customer is labelled 'unsuccessful' in the campaign statistics. The options are 1, 2, 3, 4, 5.
\n"},{"key":"interval","value":"60","type":"text","description":"Integer. Optional.
\nThe interval (in minutes) between dialing attempts to each customer within the campaign.
\n"},{"key":"working_time","value":"","type":"text","description":"String. Optional.
\nThe time when the campaign calls customers. The system uses customers’ local time. The pattern is [\"12:00:00\", \"16:00:00\"].
\nIf the empty parameter is passed, null is set; if the parameter is not passed, it remains unchanged.
\n","disabled":true},{"key":"user_ids","value":"","type":"text","description":"Integer array. Optional.
\nThe campaign agents' IDs. Use the searchUsers method to retrieve the list of user IDs.
\n","disabled":true},{"key":"mode","value":"progressive","type":"text","description":"String. Optional.
\nThe campaign mode: predictive or progressive.
\nIn the predictive mode, the campaign uses an algorithm to make predictions about agent availability and places calls based on the output of the algorithm. This algorithm uses such inputs as the number of agents, average handle time, successful/failed calls ratio, etc.
\nIn the progressive mode, the campaign places calls to agents based on the number of agents available, i.e. it dials one contact for each available agent.
\n"},{"key":"voicemail_detection_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the voicemail detection feature is enabled for the campaign.
\n","disabled":true},{"key":"voicemail_detection_model","value":"br","description":"String. Optional.
\nThe voicemail detection model to use in the campaign. \nThe options are 'ru' | 'kz' | 'colombia' | 'br' | 'mx' | 'ph' | 'pe' | 'us' | 'cl' | 'ru_experimental_vm' | 'ru_experimental_human'.
\n","type":"text","disabled":true},{"key":"voicemail_detection_timeout_sec","value":"2","description":"Float. Optional.
\nThe maximum detection time. Minimum = 1, max = 10.
\n","type":"text","disabled":true},{"key":"voicemail_detection_timeout_continue_call","value":"true","description":"Boolean. Optional.
\nSpecifies how the system should behave if it fails to detect whether it reached a live person or voicemail.
\nIf set to \"true\", the call is routed to a campaign agent. \nIf set to \"false\", the call is terminated.
\n","type":"text","uuid":"0d2dc7a7-e703-4f03-a27e-1e4438dff9bb","disabled":true},{"key":"dial_up_time_sec","value":"40","type":"text","description":"Integer. Optional.
\nThe amount of time (in seconds) an agent dials a customer before moving on to the next one.
\n"},{"key":"afterservice_time_limit_enabled","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether the after service time limit is enabled for the campaign. When enabled, the campaign agents have limited time to spend on post-call activities, like making call records, adding contacts, or assigning wrap-up codes.
\n"},{"key":"afterservice_time_limit","value":"0","type":"text","description":"Integer. Optional.
\nThe maximum time the campaign agents can spend on post-call activities (after service).
\n"},{"key":"can_outbound_record","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether outbound call recording is enabled for the campaign. When enabled, the system records all outbound calls and stores the recordings in the Call history section, so that you could listen and download them.
\nIMPORTANT! In some countries, you are compelled by law to inform the other party that you are recording the call.
\n"},{"key":"outbound_record_notification_type","value":"none","type":"text","description":"String. Optional.
\nThe notification type used to inform a customer that the call is being recorded. The options are none|media|tts.
\n"},{"key":"outbound_record_notification_duration","value":"DEFAULT","type":"text","description":"String. Optional.
\nThe time during which outbound call recordings are available for listening and downloading in the Call history sections. The options are DEFAULT|SIXMONTHS|ONEYEAR|TWOYEARS|THREEYEARS.
\n"},{"key":"tts_language","value":"","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech language for outbound call recording notifications.
\nThe following languages are available:\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft.
\n","disabled":true},{"key":"tts_voice","value":"","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech voice for outbound call recording notifications.
\nThe following options are available:
\nBengali (India):
\nEnglish (US):
\nEnglish (GB):
\nEnglish (AU):
\nEnglish (IN):
\nRussian:
\nGerman:
\nFrench:
\nFrench (CA):
\nItalian:
\nJapanese:
\nDutch:
\nTurkish:
\nKorean:
\nSwedish:
\nDanish:
\nSlovak:
\nPortuguese (BR):
\nPortuguese (PT):
\nPolish:
\nUkrainian:
\nVietnamese:
\nFilipino:
\nArabic:
\nCzech:
\nGreek:
\nFinnish:
\nHindi:
\nHungarian:
\nIndonesian:
\nNorwegian:
\nSpanish (Castilian):
\nSpanish (US):
\nKazakh (Kazakhstan):
\nSpanish (MX):
\nArabic (SA):
\nWelsh (UK):
\nIcelandic:
\nRomanian:
\nArabic:
\nChinese (Mandarin):
\nSpanish (LA):
\nAfrikaans (South Africa):
\nAmharic (Ethiopia):
\nArabic (Algeria):
\nArabic (Bahrein):
\nArabic (Egypt):
\nArabic (Iraq):
\nArabic (Jordan):
\nArabic (Kuwait):
\nArabic (Libya):
\nArabic (Morocco):
\nArabic (Qatar):
\nArabic (Syria):
\nArabic (Tunisia):
\nArabic (UAE):
\nArabic (Yemen):
\nAzerbaijani (Azerbaijan):
\nBangla (Bangladesh):
\nBulgarian:
\nBurmese (Myanmar):
\nCatalan (Spain):
\nChinese (Cantonese, Traditional):
\nChinese (Taiwanese Mandarin):
\nCroatian:
\nDutch (BE):
\nSpanish (Argentina):
\nNepali (Nepal):
\nEnglish (Canada):
\nEnglish (Hongkong):
\nEnglish (Ireland):
\nEnglish (Kenya):
\nEnglish (New Zeland):
\nEnglish (Nigeria):
\nEnglish (Philippines):
\nEnglish (South Africa):
\nEnglish (Tanzania):
\nFrench (Belgium):
\nFrench (Switzerland):
\nGalician (Spain):
\nGerman (Austria):
\nGerman (Switzerland):
\nGujarati (India):
\nIrish (Ireland):
\nJavanese (Indonesia):
\nKannada (India):
\nKazakh (Kazakhstan):
\nKhmer (Cambodia):
\nLao (Laos):
\nLithuanian (Lithuania):
\nMacedonian (North Macedonia):
\nMalay:
\nMalayalam (India):
\nMaltese (Malta):
\nMarathi (India):
\nPashto (Afghanistan):
\nPersian (Iran):
\nSerbian (Serbia, Cyrillic):
\nSinhala (Sri Lanka):
\nSlovenian:
\nSomali (Somalia):
\nSpanish (Bolivia):
\nSpanish (Chile):
\nSpanish (Costa Rica):
\nSpanish (Cuba):
\nSpanish (Dominican Republic):
\nSpanish (Ecuador):
\nSpanish (El Salvador):
\nSpanish (Equatorial Guinea):
\nSpanish (Guatemala):
\nSpanish (Honduras):
\nSpanish (Nicaragua):
\nSpanish (Panama):
\nSpanish (Paraguay):
\nSpanish (Peru):
\nSpanish (Puerto Rico):
\nSpanish (Uruguay):
\nSpanish (Venezuela):
\nSundanese (Indonesia):
\nSwahili (Tanzania):
\nTamil (India):
\nTamil (Singapore):
\nTamil (Sri Lanka):
\nTelugu (India):
\nThai:
\nUrdu (India):
\nUrdu (Pakistan):
\nZulu (South Africa):
\nUzbek:
\nHebrew: (Israel):
\nSpanish (Colombia):
\nEstonian (Estonia):
\nLatvian (Latvia):
\nString. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech text for outbound call recording notifications.
\n","disabled":true},{"key":"media_id","value":"","type":"text","description":"Integer. Required if can_outbound_record is selected and outbound_record_notification_type is media.
\nThe ID of the media file uploaded for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"client_waiting_media_id","value":"","description":"Integer. Optional.
\nThe ID of the media file that will be played to a customer while waiting for an agent. Use the searchMedia method to retrieve the list of available media files.
\n","type":"text","disabled":true},{"key":"agents_can_decline_calls","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the campaign agents can decline external calls.
\n","disabled":true},{"key":"region_enabled","value":"true","type":"text","description":"Boolean. Optional.\nSpecifies whether the region to launch campaign calls is specified.
\n","disabled":true},{"key":"region","value":"europe","type":"text","description":"String. Required if the \"region_enabled\" flag is true. \nThe options are usa | europe | south_america | singapore | russia | kazakhstan.
\n","disabled":true},{"key":"call_auto_answer","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the auto-answer calls feature is enabled for the campaign. When an inbound call comes in, the system automatically connects a customer to an agent.
\n","disabled":true},{"key":"dnc_lists","value":"","type":"text","description":"Integer array. Optional.
\nThe DNC list ID(s) bound to the campaign. The contacts put on those lists do not receive calls within the campaign. Use the searchDncList method to retrieve the list of DNC list IDs.
\n","disabled":true},{"key":"wrap_up_codes_set_id","value":"","type":"text","description":"Integer. Optional.
\nThe wrap-up codes set ID.
\nYou assign a wrap-up codes set to a campaign if you want the campaign agents to label the outcome of their calls after interaction with a customer.
\n","disabled":true},{"key":"wrap_up_dnc_list_id","value":"","type":"text","description":"Integer. Optional.
\nThe ID of the DNC list bound to the campaign in conjunction with a wrap-up codes set.
\nIf the wrap-up codes set you attached to the campaign contains the Add to DNC list code, the system prompts you to bind a DNC list.
\n","disabled":true},{"key":"id","value":"2406","type":"text","description":"Integer. Required.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n"},{"key":"task_multiplier","value":"","description":"Float. Optional.
\nThe campaign workload distribution factor. The parameter applies to progressive PDS campaigns only. It determines the pace of placing calls to each idle agent. The minimum value is 1.0, maximum - 25.0. For campaigns with more than 20 agents, the limit is 100.
\n","type":"text","disabled":true},{"key":"abandonment_rate","value":"","description":"Integer. Optional.
\nThe campaign abandon rate parameter. Applies to predictive PDS campaigns only. It determines the pace of placing calls by adjusting the percentage of abandoned calls. The minimum value is 1, maximum - 100.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/agentCampaigns/updateCampaign?domain={{domain}}","description":"Updates a PDS campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","updateCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"17adabe0-df54-48e4-bf7a-bfe4e28070bc","name":"updateCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"title","value":"Test PDS campaign","type":"text"},{"key":"caller_id","value":"","type":"text","disabled":true},{"key":"sip_number_id","value":"","type":"text","description":"Integer. Optional.\n\nThe identifier of the external number used for the campaigns' outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.","disabled":true},{"key":"max_attempts","value":"3","type":"text"},{"key":"interval","value":"60","type":"text"},{"key":"working_time","value":"","type":"text","disabled":true},{"key":"user_ids","value":"","type":"text","disabled":true},{"key":"mode","value":"progressive","type":"text"},{"key":"voicemail_detection_enabled","value":"false","type":"text"},{"key":"dial_up_time_sec","value":"40","type":"text"},{"key":"afterservice_time_limit_enabled","value":"false","type":"text"},{"key":"afterservice_time_limit","value":"0","type":"text"},{"key":"can_outbound_record","value":"false","type":"text"},{"key":"outbound_record_notification_type","value":"none","type":"text"},{"key":"outbound_record_notification_duration","value":"DEFAULT","type":"text"},{"key":"tts_language","value":"","type":"text","disabled":true},{"key":"tts_voice","value":"","type":"text","disabled":true},{"key":"tts_text","value":"","type":"text","disabled":true},{"key":"properties","value":"[]","type":"text","disabled":true},{"key":"agents_can_decline_calls","value":"false","type":"text","disabled":true},{"key":"call_auto_answer","value":"false","type":"text","disabled":true},{"key":"dnc_lists","value":"[]","type":"text","disabled":true},{"key":"wrap_up_codes_set_id","value":"","type":"text","disabled":true},{"key":"wrap_up_dnc_list_id","value":"","type":"text","disabled":true},{"key":"id","value":"2406","type":"text"},{"key":"task_multiplier","value":"1.0","type":"text","disabled":true},{"key":"abandonment_rate","value":"3","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/updateCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","updateCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 07:08:03 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"cf666a5ab5a38becdf48f084b1353a1b"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 2406,\n \"title\": \"Test PDS campaign\",\n \"status\": \"draft\",\n \"mode\": \"progressive\",\n \"folder_id\": null,\n \"date_start\": null,\n \"date_end\": null,\n \"working_time\": [\n \"\",\n \"\"\n ],\n \"max_attempts\": 3,\n \"interval\": 60,\n \"phone_number_id\": 268,\n \"caller_id\": null,\n \"settings\": {\n \"voicemail_detection_enabled\": false,\n \"dial_up_time_sec\": 40,\n \"outbound_call_recording\": {\n \"enabled\": false,\n \"notification\": {\n \"type\": \"none\",\n \"tts_text\": null,\n \"tts_voice\": null,\n \"tts_language\": null,\n \"media_id\": null\n },\n \"storage_period\": \"DEFAULT\"\n }\n },\n \"create_date\": \"2023-03-20 12:50:26\",\n \"created_by\": 1721,\n \"edit_date\": \"2023-03-22 07:08:03\",\n \"edited_by\": 1721,\n \"queue\": {\n \"id\": 3471,\n \"title\": \"Test PDS campaign\",\n \"operator_priority_strategy\": \"MAX_WAITING_TIME\",\n \"request_priority_strategy\": \"MAX_PRIORITY\",\n \"afterservice_time_limit_enabled\": false,\n \"afterservice_time_limit\": 0,\n \"agents_can_end_calls\": true,\n \"agents_can_decline_calls\": true\n },\n \"timezone\": \"UTC\",\n \"sip_number_id\": null,\n \"use_tags\": true,\n \"use_topics\": false,\n \"topic_set_id\": null,\n \"task_multiplier\": 1,\n \"abandonment_rate\": 3,\n \"reference_ip\": \"\",\n \"wrap_up_codes_set_id\": null,\n \"wrap_up_dnc_list_id\": null,\n \"dnc_lists\": []\n }\n}"}],"_postman_id":"7f146e06-cd74-48eb-acd2-77591784c4e0"},{"name":"setCampaignStatus","id":"1cba289d-90a1-44cc-8b53-250e51978c39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"2406","type":"text","description":"Integer. Required.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n"},{"key":"status","value":"completed","type":"text","description":"String. Required.
\nThe campaign status you want to set. The options are ongoing|paused|completed.
\n"}]},"url":"https://{{host}}/api/v3/agentCampaigns/setCampaignStatus?domain={{domain}}","description":"Sets a PDS campaign status.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","setCampaignStatus"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"6abd9b14-39ce-4ce2-a4f7-aee434b749b2","name":"setCampaignStatus","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"2406","type":"text"},{"key":"status","value":"completed","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/setCampaignStatus?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","setCampaignStatus"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 07:54:57 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"544397ff31fed2816617a7a40d2de1d4"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"1cba289d-90a1-44cc-8b53-250e51978c39"},{"name":"setListStatus","id":"a3857cbd-c1d9-412c-a29c-12c00485ec92","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n","type":"text"},{"key":"id","value":"2243","description":"Integer. Required.
\nThe contact list ID. Use the searchCampaignLists method to retrieve available contact lists.
\n","type":"text"},{"key":"status","value":"ongoing","description":"String. Required.
\nThe contact list status you want to set. The available options are ongoing|paused|canceled.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/agentCampaigns/setListStatus?domain={{domain}}","description":"Sets a status of a PDS campaign contact list.
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","setListStatus"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c1b0b410-8e2e-4d8b-ba80-4c1b02bd1851","name":"setListStatus","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"2243","type":"text"},{"key":"status","value":"ongoing","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/setListStatus?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","setListStatus"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 08:08:27 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"087354bc94d26b4ba568a6a8392585d2"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"a3857cbd-c1d9-412c-a29c-12c00485ec92"},{"name":"searchContacts","id":"45f7d4d9-8249-4bcc-907a-1c90f8b4b496","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n","type":"text"},{"key":"id","value":"5296624","type":"text","description":"Integer. Optional.
\nThe particular contact ID to filter.
\n"},{"key":"campaign_id","value":"","type":"text","description":"Integer. Optional.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n","disabled":true},{"key":"campaign_list_id","value":"","type":"text","description":"Array or integer. Optional.
\nThe campaign contact list ID. Use the searchCampaignLists method to retrieve available contact lists.
\n","disabled":true},{"key":"phone","value":"17474888510","type":"text","description":"Integer. Optional.
\nThe particular contact phone number to filter.
\n"},{"key":"status","value":"","description":"Array. Optional.
\nContact statuses. The options are ongoing|success|failed|canceled. Example: [\"success\", \"ongoing\"].
\n","type":"text","disabled":true},{"key":"from","value":"2021-09-25 00:00:00","description":"String. Optional.
\nThe report start date and time. The pattern is YYYY-MM-DD HH:mm:ss.
\n","type":"text"},{"key":"to","value":"2023-10-25 00:00:00","description":"String. Optional.
\nThe report end date and time. The pattern is YYYY-MM-DD HH:mm:ss.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/agentCampaigns/searchContacts?domain={{domain}}","description":"Retrieves a list of campaign contacts.
\nIf you define specific parameters, the request returns only the contacts that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","searchContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"e6d1903d-f188-41fb-aeda-3dacde038012","name":"searchContacts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"","type":"text","disabled":true},{"key":"campaign_id","value":"","type":"text","disabled":true},{"key":"campaign_list_id","value":"","type":"text","disabled":true},{"key":"phone","value":"17474888510","type":"text"},{"key":"status","value":"","type":"text","disabled":true},{"key":"from","value":"","type":"text","disabled":true},{"key":"to","value":"","type":"text","disabled":true},{"key":"with_canceler","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/searchContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","searchContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 08:46:00 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"56f6600f7feb9c85f391c5e4e7e0514d"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n","type":"text"},{"key":"campaign_id","value":"2413","type":"text","description":"Integer. Required.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n"},{"key":"rows","value":"[{\"phone\":\"17474888510\",\"UTC\":\"America/Aruba\"}]","type":"text","description":"JSON array. Required.
\nThe rows you want to add to the campaign contact list. Maximum is 5000. The phone and UTC fields are required. Example: [{\"phone\":\"17478092817\",\"UTC\":\"America/Aruba\"}].
\nIMPORTANT! The \"rows\" parameter must contain the same set of fields (phone, UTC, etc.) in one API request.
\nCorrect: [{\"phone\":\"17474888510\",\"UTC\":\"America/Aruba\", \"client_id\":\"12345\"}, {\"phone\":\"17474880000\",\"UTC\":\"America/NY\", \"client_id\":\"54321\"}]
\nIncorrect: [{\"phone\":\"17474888510\",\"UTC\":\"America/Aruba\"}, {\"phone\":\"17474880000\",\"UTC\":\"America/NY\", \"client_id\":\"54321\"}]
\n"}]},"url":"https://{{host}}/api/v3/agentCampaigns/appendContacts?domain={{domain}}","description":"Adds contacts to an existing PDS campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","appendContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"2ac2c5ae-be8e-4516-a71d-608e10fd5e4d","name":"appendContacts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"campaign_id","value":"2413","type":"text"},{"key":"rows","value":"[{\"phone\":\"17474888511\",\"UTC\":\"America/Aruba\"}]","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/appendContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","appendContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 09:07:51 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4bd1a88f53da8591e2bdbc61e82e1da3"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"list_id\": 3265,\n \"count\": 1,\n \"success_count\": 1,\n \"errors_count\": 0,\n \"fail_list\": []\n }\n}"}],"_postman_id":"ce67fb50-2216-4a84-b8be-7a0e6be3517b"},{"name":"searchCampaignLists","id":"8c5357e9-273d-4589-be77-81553aed3881","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"","description":"Integer. Optional.
\nThe particular contact list ID to filter.
\n","type":"text","disabled":true},{"key":"status","value":"","description":"Array. Optional.
\nContact list statuses. The available options are processing|ongoing|paused|completed. Example: [\"processing\", \"ongoing\"].
\n","type":"text","disabled":true},{"key":"agent_campaign_id","value":"","description":"Integer. Optional.
\nThe campaign ID that uses the contact list(s) you search for. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/agentCampaigns/searchCampaignLists?domain={{domain}}","description":"Retrieves a list of campaign contact lists.
\nIf you define specific parameters, the request returns only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","searchCampaignLists"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"key":"per-page","value":""},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting. The options are id|title|status|date_start|date_end|date_create|folder_id.
\n","type":"text/plain"},"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"d6a14507-6487-4f90-a6c2-7c33d208ca22","name":"searchCampaignLists","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"YOUR_ACCESS_TOKEN","type":"text"},{"key":"id","value":"","type":"text","disabled":true},{"key":"status","value":"[\"ongoing\"]","type":"text"},{"key":"agent_campaign_id","value":"1618","type":"text"}]},"url":{"raw":"https://YOUR_ACCOUNT_API_DOMAIN/api/v3/agentCampaigns/searchCampaignLists?domain=YOUR_ACCOUNT_NAME","protocol":"https","host":["YOUR_ACCOUNT_API_DOMAIN"],"path":["api","v3","agentCampaigns","searchCampaignLists"],"query":[{"key":"domain","value":"YOUR_ACCOUNT_NAME","description":"Your account name."},{"key":"per-page","value":"","type":"text","disabled":true},{"key":"sort","value":"-id","description":"id|title|status|date_start|date_end|date_create|folder_id","type":"text","disabled":true},{"key":"page","value":"2","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 09:17:38 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"47b55947f3dd1047ec7c08ab19109513"},{"key":"X-Pagination-Total-Count","value":"2"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"campaign_id","value":"305","type":"text","description":"String. Required.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n"},{"key":"contact_ids","value":"[115026]","description":"Array. Required.
\nThe contact ID(s) you want to cancel. Use the searchContacts method to retrieve the list of available contacts.
\n","type":"text"},{"key":"comment","value":"test","description":"String. Optional.
\nAny additional information.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/agentCampaigns/cancelContacts?domain={{domain}}","description":"Cancels specific contacts within a PDS campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","cancelContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"76548ce0-93e8-4f42-9e07-64edc65252f1","name":"cancelContacts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"campaign_id","value":"2413","type":"text"},{"key":"contact_ids","value":"[5296625]","type":"text"},{"key":"comment","value":"no longer valid for the current timezone","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/cancelContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","cancelContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 09:24:28 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"24f179d9d9de04c84bbba42377bb8ff4"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"8556a798-1bcb-456b-a545-c925db18a193"},{"name":"addAttempts","id":"1a232f69-92f5-4470-a6bb-38d6c787c992","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"campaign_id","value":"2413","type":"text","description":"Integer. Required.
\nThe campaign ID. Use the searchCampaigns method to retrieve the list of available PDS campaigns.
\n"},{"key":"contact_ids","value":"[5296625]","description":"Array. Required.
\nThe contact ID(s) you want to add dialing attempts to. Use the searchContacts method to retrieve the list of available contacts.
\n","type":"text"},{"key":"interval","value":"1","type":"text","description":"String. Required.
\nThe time between calling attempts to a customer.
\n"},{"key":"max_attempts","value":"2","type":"text","description":"Integer. Required.
\nThe maximum number of attempts to reach a customer.
\n"}]},"url":"https://{{host}}/api/v3/agentCampaigns/addAttempts?domain={{domain}}","description":"Adds dialing attempts to specific contacts within a PDS campaign.
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","addAttempts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"e903851b-2ddb-45b7-949a-87e1c6464148","name":"addAttempts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"campaign_id","value":"2413","type":"text"},{"key":"contact_ids","value":"[5296625]","type":"text"},{"key":"interval","value":"1","type":"text"},{"key":"max_attempts","value":"2","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/addAttempts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","addAttempts"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 09:45:38 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"ef1265111cdcfa55c3b56ef791407119"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"1a232f69-92f5-4470-a6bb-38d6c787c992"},{"name":"getStat","id":"74f47b06-9dfc-430e-a30d-942d855eede4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"}]},"url":"https://{{host}}/api/v3/agentCampaigns/getStat?domain={{domain}}","description":"Gets the total PDS campaign count by status.
\n","urlObject":{"protocol":"https","path":["api","v3","agentCampaigns","getStat"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"e422a254-b53f-489f-a025-a5c8cdc304ac","name":"getStat","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentCampaigns/getStat?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentCampaigns","getStat"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 20 Mar 2023 14:42:21 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"24e19dedda705d90459426b69587d063"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"draft\": 3,\n \"paused\": 1,\n \"ongoing\": 0,\n \"scheduled\": 0,\n \"completed\": 11,\n \"total\": 15\n }\n}"}],"_postman_id":"74f47b06-9dfc-430e-a30d-942d855eede4"}],"id":"35cddb0a-c2fb-4a74-9c1c-fdd5b3271e42","description":"This folder contains actions you may need to manage PDS campaigns.
\nA PDS campaign is a dialing campaign that uses agents to call customers. The unique feature of a PDS campaign is that it assigns phone calls to agents before they become available. This approach increases agents’ efficiency by dialing as many customers as possible.
\n","_postman_id":"35cddb0a-c2fb-4a74-9c1c-fdd5b3271e42"},{"name":"agentStatus","item":[{"name":"searchStatuses","id":"4c5aa6e5-5071-47ed-bfc9-a0f9377e311f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"[632,634]","type":"text","description":"Integer array. Optinal.
\nThe particular status ID(s) to filter.
\n"},{"key":"active","value":"true","description":"Boolean. Optional.
\nSpecifies whether a status is active.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/agentStatuses/searchStatuses?domain={{domain}}","description":"Retrieves a list of all agent statuses, including system and custom ones.
\nIf you define specific query parameters, the request retrieves only the agent statuses that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","agentStatuses","searchStatuses"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"ea1ceb20-6475-4f09-ad2e-a5cb4f909685","name":"searchStatuses","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your API token."},{"key":"active","value":"true","type":"text","description":"Status activity. Optional, boolean. "},{"key":"id","value":"[632,634]","type":"text","description":"Status ID. Optinal, integer array."}]},"url":{"raw":"https://{{host}}/api/v3/agentStatuses/searchStatuses?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentStatuses","searchStatuses"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 21 Mar 2023 11:00:34 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"37bc1417bcbed066fe14132def814b4c"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 632,\n \"key\": \"OFFLINE\",\n \"title\": \"Offline\",\n \"color\": \"C6CACC\",\n \"active\": true,\n \"system\": true,\n \"description\": null,\n \"order\": 0\n },\n {\n \"id\": 634,\n \"key\": \"IN_SERVICE\",\n \"title\": \"In Service\",\n \"color\": \"367BF5\",\n \"active\": true,\n \"system\": true,\n \"description\": null,\n \"order\": 3\n }\n ]\n}"}],"_postman_id":"4c5aa6e5-5071-47ed-bfc9-a0f9377e311f"},{"name":"createStatus","id":"c5514407-234a-49b2-a71c-0abe2d54d755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"color","value":"F3AA18","description":"String. Optional.
\nThe color of the new status. Defaults on F3AA18.
\n"},{"key":"title","value":"Lunch","type":"text","description":"String. Required.
\nThe status name. The maximum length is 20 characters.
\n"},{"key":"active","value":"true","type":"text","description":"Boolean. Required.
\nSpecifies whether the status is active.
\n"},{"key":"order","value":"","type":"text","description":"Integer. Optional.
\nThe status order number. The minimum value is 10. The default value is 0.
\n","disabled":true},{"key":"description","value":"1-hour lunch break","description":"String. Optional.
\nThe status description. The maximum length is 255 characters.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/agentStatuses/createStatus?domain={{domain}}","description":"Creates a custom agent status.
\n","urlObject":{"protocol":"https","path":["api","v3","agentStatuses","createStatus"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c34cbe42-613a-42af-bd9e-ab4441602d6f","name":"createStatus","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your API token."},{"type":"text","key":"color","value":"F3AA18","description":"String. Required.\n\nThe color of the new status."},{"key":"title","value":"Lunch","type":"text","description":"String. Required.\n\nThe status name. The maximum length is 20 characters."},{"key":"active","value":"true","type":"text","description":"Boolean. Required.\n\nSpecifies whether the status is active."},{"key":"order","value":"13","type":"text","description":"Integer. Optional.\n\nThe status order number. The minimum value is 10; defaults to 0. ","disabled":true},{"key":"description","value":"1-hour lunch break","description":"String. Optional.\n\nThe status description. The maximum length is 255 characters. \n","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/agentStatuses/createStatus?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentStatuses","createStatus"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 12 May 2023 12:42:41 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4ced283f4f90ce80751e2565acf1b548"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 4192,\n \"title\": \"Lunch\",\n \"key\": \"CUSTOM_6\",\n \"color\": \"F3AA18\",\n \"active\": true,\n \"system\": false,\n \"description\": \"1-hour lunch break\",\n \"order\": 800\n }\n}"}],"_postman_id":"c5514407-234a-49b2-a71c-0abe2d54d755"},{"name":"updateStatus","id":"e01cf4cf-c725-413f-8701-4d0a88f4bc64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"id","value":"4004","description":"Integer. Required.
\nThe status ID. Use the searchStatuses method to retrieve the list of available statuses.
\n"},{"type":"text","key":"title","value":"On training","description":"String. Optional.
\nThe status name. The maximum length is 20 characters.
\n"},{"type":"text","key":"active","value":"","description":"Boolean. Optional.
\nSpecifies whether a status is active.
\n","disabled":true},{"key":"order","value":"","description":"Integer. Optional.
\nThe status order number. The minimum value is 10.
\n","type":"text","disabled":true},{"key":"description","value":"Educational courses","description":"String. Optional. Nullable.
\nThe status description. The maximum length is 255 characters.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/agentStatuses/updateStatus?domain={{domain}}","description":"Updates an agent status.
\nNOTE: You can only update the system status name and description. Renaming a system status does not change its meaning; its color and behavior remain the same.
\n","urlObject":{"protocol":"https","path":["api","v3","agentStatuses","updateStatus"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"15c04e3d-d18c-4f60-a080-ae803332c829","name":"updateStatus","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"Your API token."},{"type":"text","key":"id","value":"4004","description":"Integer. Required.\n\nStatus ID. "},{"type":"text","key":"title","value":"On training","description":"String. Optional.\n\nStatus name. Maximum 20 characters. "},{"type":"text","key":"color","value":"","description":"String. Optional.\n\nStatus color. Maximum 6 characters. ","disabled":true},{"type":"text","key":"active","value":"","description":"Boolean. Optional.\n\nSpecifies whether a status is active.","disabled":true},{"key":"description","value":"Educational courses","description":"String. Optional, nullable.\n\nStatus description. Maximum 255 characters. ","type":"text"},{"key":"order","value":"1","description":"Integer. Optional.\n\nStatus order number. Minimum value is 10. ","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/agentStatuses/updateStatus?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentStatuses","updateStatus"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 31 Mar 2023 12:32:50 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"ae76762e4207ed530d8a555f84a855ca"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 4004,\n \"title\": \"On training\",\n \"key\": \"CUSTOM_1\",\n \"color\": \"F3AA18\",\n \"active\": true,\n \"system\": false,\n \"description\": \"Educational courses\",\n \"order\": 300\n }\n}"}],"_postman_id":"e01cf4cf-c725-413f-8701-4d0a88f4bc64"},{"name":"deleteStatus","id":"be3c88c3-39d9-4ebe-ac16-eb201afdb0ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"id","value":"2117","description":"Integer. Required.
\nThe status ID. Use the searchStatuses method to retrieve the list of available statuses.
\n"}]},"url":"https://{{host}}/api/v3/agentStatuses/deleteStatus?domain={{domain}}","description":"Deletes an agent status.
\nNOTE: You cannot delete system statuses.
\n","urlObject":{"protocol":"https","path":["api","v3","agentStatuses","deleteStatus"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"ebaf1aed-ac09-4c80-a42b-6a793feaf04d","name":"deleteStatus","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}"},{"type":"text","key":"id","value":"2117","description":"Required, int."}]},"url":{"raw":"https://{{host}}/api/v3/agentStatuses/deleteStatus?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","agentStatuses","deleteStatus"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 09 Mar 2023 07:42:07 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"815f43ee8a3188ed10f25825e7eb6a28"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"be3c88c3-39d9-4ebe-ac16-eb201afdb0ae"}],"id":"0e6de1a1-b22f-4642-a73a-d87bbc7b3b64","description":"This folder contains actions you may need to manage agent statuses.
\nStatuses are used to determine whether an agent can make and receive calls. By default, Voximplant Kit offers the following system statuses: Ready, Dialing, In service, After service, Banned, Offline, Online, DND. In addition, you can create custom statuses.
\n","_postman_id":"0e6de1a1-b22f-4642-a73a-d87bbc7b3b64"},{"name":"bot-service","item":[{"name":"sendTemplateMessage","id":"6a434bb8-84b9-4742-9c14-665c2348c90c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n","type":"text"},{"key":"client_id","value":"+123123123","description":"String. Required.
\nThe phone number of the recipient in e164 format.
\n","type":"text"},{"key":"channel_id","value":"1","description":"Integer. Required.
\nThe WhatsApp channel ID in which the template you want to send was created and registered.
\nTo get the channel ID:
\nInteger. Required.
\nThe identifier of the HSM template. Use the https://{{host}}/api/v3/whatsappHsmTemplates/search method to retrieve the list of available HSM templates.
\nOnly approved templates from your group collections are available for sending.
\n","type":"text"},{"key":"header_param_value","value":"John","description":"String. Optional.
\nHeader variable value.
\nThe value must not contain single curly brackets \"{}\".
\n","type":"text"},{"key":"header_attachment_id","value":"1","description":"Integer. Optional.
\nTemplate header attachment identifier.
\n","type":"text"},{"key":"header_url","value":"https://upload.wikimedia.org/wikipedia/commons/thumb/6/6b/WhatsApp.svg/300px-WhatsApp.svg.png","description":"String. Optional.
\nTemplate header attachment URL.
\n","type":"text"},{"key":"text_param_values","value":"{\"order\": \"123\", \"duration\": \"2\"}","description":"String. Optional.
\nMessage body variables (if any) with values.
\nMessage body variable values must not contain double curly brackets \"{{}}\".
\n","type":"text"},{"key":"button_url_param_value","value":"Go","description":"String. Optional.
\nDynamic part of the button URL, if applicable.
\n","type":"text"},{"key":"user_id","value":"123","description":"Integer. Optional.
\nThe identifier of the user who will receive the customer's response to the template message. Use the searchUsers method to retrieve the list of available user IDs.
\nIf you do not specify the user ID, the system routes the customer's response to a queue or function.
\n","type":"text"},{"key":"variables","value":"{\"var1\": \"abc123\", \"var2\": \"def\", \"var3\": \"456\"}","description":"JSON object. Optional.
\nTemplate variables.
\nThe maximum number of variables (key + value) is 20. \nEach variable name is a string, max length - 20 characters.\nEach variable value is a string, max length - 200 characters.
\n","type":"text","uuid":"a48f4bf6-7831-4a78-8950-eda583bdf966","disabled":true}]},"url":"https://{{messaging-host}}/api/v3/botService/sendTemplateMessage?domain={{domain}}","description":"Sends a WhatsApp HSM template.
\nNOTE: The rate limit is 10 requests per second.
\n","urlObject":{"protocol":"https","path":["api","v3","botService","sendTemplateMessage"],"host":["{{messaging-host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"8d6711d7-0980-4334-9532-a86f75ab56de","name":"sendTemplateMessage","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"+123123123","description":"String. Required.\n\nThe phone number of the recipient in e164 format.","type":"text"},{"key":"channel_id","value":"1","description":"Integer. Required.\n\nThe WhatsApp channel ID in which the template you want to send was created and registered.","type":"text"},{"key":"message_template_id","value":"1","description":"Integer. Required.\n\nThe identifier of the HSM-template. Only approved templates from your group collections are available for sending.","type":"text"},{"key":"header_param_value","value":"John","description":"String. Optional.\n\nHeader variable value. \n\n","type":"text"},{"key":"header_attachment_id","value":"1","description":"Integer. Optional.\n\nTemplate header attachment identifier.","type":"text"},{"key":"header_url","value":"https://upload.wikimedia.org/wikipedia/commons/thumb/6/6b/WhatsApp.svg/300px-WhatsApp.svg.png","description":"String. Optional.\n\nTemplate header attachment URL.","type":"text"},{"key":"text_param_values","value":"{\"order\": \"123\", \"duration\": \"2\"}","description":"String. Optional.\n\nMessage body variables (if any) with values.\n","type":"text"},{"key":"button_url_param_value","value":"Go","description":"String. Optional.\n\nThe attached button URL.","type":"text"},{"key":"user_id","value":"123","description":"Integer. Required for API token requests.","type":"text"},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token.","type":"text"}]},"url":{"raw":"https://{{bot-host}}/api/v3/botService/sendTemplateMessage?domain={{domain}}","protocol":"https","host":["{{bot-host}}"],"path":["api","v3","botService","sendTemplateMessage"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"conversation_uuid\": \"a81bc81b-dead-4e5d-abff-90000000000\",\n \"incoming_request_id\": 12345,\n \"message_uuid\": \"550e8400-e29b-41d4-a716-00000000000\"\n }\n}"}],"_postman_id":"6a434bb8-84b9-4742-9c14-665c2348c90c"},{"name":"sendMessage","id":"a296cc3b-3ae8-4e47-b8b7-d755876af084","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"conversation_uuid","type":"text","value":"b3ce1b69-38a9-4a40-b1ba-1111111111111","description":"String. Required.
\nThe chat UUID you want to send a bot message to. You can copy it in your Workspace or in the History > Messaging section.
\n"},{"key":"text","value":"Hello","type":"text","description":"String. Required.
\nYour message text.
\n"},{"key":"payload","value":"[{\"type\": \"photo\",\"file_id\": 123}]","type":"text","description":"JSON array. Optional. Required if text is not specified.
\nMessage attachment.
\n","disabled":true}]},"url":"https://{{messaging-host}}/api/v3/botService/sendMessage?domain={{domain}}","description":"Sends a bot message to a particular chat.
\n","urlObject":{"protocol":"https","path":["api","v3","botService","sendMessage"],"host":["{{messaging-host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c7232b1a-3f91-4116-bb16-ee06242dbe0c","name":"sendMessage","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"conversation_uuid","type":"text","value":"b3ce1b69-38a9-4a40-b1ba-272131562951"},{"key":"payload","value":"[{\"type\": \"photo\",\"file_id\": 123}]","type":"text","disabled":true},{"key":"text","value":"answer 123","type":"text"}]},"url":{"raw":"https://{{bot-host}}/api/v3/botService/sendMessage?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{bot-host}}"],"path":["api","v3","botService","sendMessage"],"query":[{"key":"domain","value":"{{domain}}"},{"key":"access_token","value":"{{access_token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"a296cc3b-3ae8-4e47-b8b7-d755876af084"}],"id":"217d46d2-d042-4ee0-918d-87d24e083d80","description":"This folder contains actions you may need to initiate an outbound conversation with a customer using HSM templates and to send bot messages to a specific chat.
\n","_postman_id":"217d46d2-d042-4ee0-918d-87d24e083d80"},{"name":"callback","item":[{"name":"Callbacks","item":[{"name":"scenario_created","item":[],"id":"4a525c8a-4285-4630-8f48-d099574b049d","description":"Triggered when: a scenario is created/copied.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f877877860f1bd3308b5fde1f26e17e7\",\n \"scenario_created\": {\n \"callback_id\": 37,\n \"domain_name\": \"Your account name\",\n \"scenario_id\": 5007\n },\n \"type\": \"scenario_created\"\n }\n ]\n}\n\nTriggered when: a scenario is published/renamed.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"1fb7df536ec0f7c7575c480313c97aa5\",\n \"scenario_updated\": {\n \"callback_id\": 37,\n \"domain_name\": \"Your account name\",\n \"scenario_id\": 5007\n },\n \"type\": \"scenario_updated\"\n }\n ]\n}\n\nTriggered when: a scenario is deleted.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f31c66d34ed05f012516ca02178e6996\",\n \"scenario_deleted\": {\n \"callback_id\": 37,\n \"domain_name\": \"Your account name\",\n \"scenario_id\": 5007\n },\n \"type\": \"scenario_deleted\"\n }\n ]\n}\n\nTriggered when: a Caller ID is activated/deactivated.
\nData object:
\n{\n \"callbacks\": [\n {\n \"caller_id_changed\": {\n \"callback_id\": 37,\n \"caller_ids\": [{ // account Caller IDs\n \"id\":1,\n \"callerid_number\":\"1742000000\",\n \"active\": true,\n \"verified_until\":2021-10-10 01:00:00\n }],\n \"domain_name\": \"Your account name\"\n },\n \"hash\": \"5cacb242065a6582c8ca811615a2f770\",\n \"type\": \"caller_id_changed\"\n }\n ]\n}\n\nTriggered when: a phone number is purchased, frozen, or changed during synchronization, verification period is over or extended, verification failed.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"a06835d562f95b241a9165d982114cd7\",\n \"numbers_changed\": {\n \"callback_id\": 37,\n \"domain_name\": \"Your account name\",\n \"phone_numbers\": [\n {\n \"auto_charge\": true,\n \"can_be_used\": true,\n \"canceled\": false,\n \"category_name\": \"GEOGRAPHIC\",\n \"deactivated\": false,\n \"domain_id\": 169,\n \"id\": 434,\n \"phone_country_code\": \"US\",\n \"phone_next_renewal\": \"2023-09-30\",\n \"phone_number\": \"17426321553\",\n \"phone_price\": \"114.8484\",\n \"phone_purchase_date\": \"2023-08-30 15:43:55\",\n \"phone_region_id\": null,\n \"redirect_number\": null,\n \"required_verification\": null,\n \"unverified_hold_until\": null,\n \"verification_status\": \"NOT_REQUIRED\"\n }\n ]\n },\n \"type\": \"numbers_changed\"\n }\n ]\n}\n\nTriggered when: a profile email address is updated.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"156e11f0c734ec0aa6442aba6496a7e5\",\n \"profile_email_updated\": {\n \"avatar\": \"https://youravatar.png\",\n \"callback_id\": 37,\n \"domain_name\": \"Your account name\",\n \"email\": \"jsmith@voximplant.com\",\n \"first_name\": \"John\",\n \"full_name\": \"John Smith\",\n \"lang\": \"en\",\n \"last_name\": \"Smith\",\n \"middle_name\": null,\n \"utc\": \"America/Anchorage\"\n },\n \"type\": \"profile_email_updated\"\n }\n ]\n}\n\nTriggered when: a new call is counted.
\nUse the completion_code field to determine how the call attempt ended. For possible values, see Completion codes.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"8f5806485d8c20490e0a527d7b11125e\",\n \"new_calls\": {\n \"callback_id\": 38,\n \"calls\": [\n {\n \"agent_campaign_id\": 3230,\n \"agent_campaign_list_item_id\": 5549965,\n \"attempt_num\": 1,\n \"call_calls\": \"[{\\\"call_id\\\":86265838,\\\"cost\\\":1.881356,\\\"duration\\\":36,\\\"start_time\\\":\\\"2023-08-30 16:10:12\\\",\\\"successful\\\":true,\\\"transaction_id\\\":1757373580012,\\\"remote_number\\\":\\\"17420000000\\\",\\\"remote_number_type\\\":\\\"pstn\\\",\\\"local_number\\\":\\\"17420000000\\\",\\\"incoming\\\":false},{\\\"call_id\\\":86265839,\\\"cost\\\":0,\\\"duration\\\":34,\\\"start_time\\\":\\\"2023-08-30 16:10:15\\\",\\\"successful\\\":true,\\\"transaction_id\\\":0,\\\"remote_number\\\":\\\"user-746\\\",\\\"remote_number_type\\\":\\\"user\\\",\\\"local_number\\\":\\\"17420000000\\\",\\\"incoming\\\":false}]\",\n \"call_cost\": 1.881356,\n \"call_data\": {\n \"UTC\": \"3\",\n \"date\": \"2021-05-18 17:26:41\",\n \"name\": \"name\",\n \"next_attempt_interval\": null,\n \"phone\": \"17420000000\"\n },\n \"call_records\": \"[]\",\n \"call_resources\": \"[]\",\n \"call_result_code\": 200,\n \"call_status\": \"\",\n \"calllist_item_id\": 0,\n \"campaign_id\": null,\n \"completion_code\": null,\n \"datetime_start\": \"2023-08-30T16:09:54\",\n \"dialing_time\": 17,\n \"domain_id\": 21,\n \"duration\": 36,\n \"id\": 2933958,\n \"is_incoming\": false,\n \"phone_a\": \"17420000000\",\n \"phone_b\": \"17420000333\",\n \"processing\": false,\n \"recalc\": true,\n \"record_url\": \"\",\n \"scenario_id\": null,\n \"scenario_version_id\": null,\n \"session_id\": 84611651,\n \"tags\": [\n {\n \"id\": 637,\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Customer issues\",\n \"tag_name\": \"Complaints\"\n },\n {\n \"id\": 640,\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Goods return\",\n \"tag_name\": \"Returns\"\n },\n {\n \"id\": 642,\n \"tag_color\": \"--orange_10\",\n \"tag_description\": \"VIP customer\",\n \"tag_name\": \"Synenergy\"\n }\n ],\n \"topics\": [\n {\n \"created_at\": \"2023-08-30T16:10:39\",\n \"created_by\": 1209,\n \"id\": 2031,\n \"path\": [\n \"Middle East\",\n \"India\",\n \"Bangalore\"\n ],\n \"topic_id\": 1266,\n \"topic_name\": \"Asian customers\",\n \"topic_set_id\": 303\n }\n ],\n \"user_id\": 1209,\n \"wrap_up_code\": null\n }\n ],\n \"domain_id\": 21,\n \"domain_name\": \"Your account name\",\n \"partner_id\": 0\n },\n \"type\": \"new_calls\"\n }\n ]\n}\n\nTriggered when: a call is answered by an agent.
\nData object:
\n{\n \"callbacks\": [\n {\n \"call_assigned_to_agent\": {\n \"callback_id\": 38,\n \"data\": {\n \"agent\": {\n \"email\": \"jsmith@voximplant.com\",\n \"first_name\": \"John\",\n \"full_name\": \"John Smith\",\n \"id\": 1209,\n \"last_name\": \"Smith\",\n \"middle_name\": \"null\",\n \"username\": \"user-746\"\n },\n \"assign_type\": \"queue_call\" | \"group_call\" | \"user_call\" | \"internal_call\" | \"transfer\",\n \"call\": {\n \"IVR_RESULT_1\": \"\",\n \"IVR_RESULT_2\": \"\",\n \"IVR_RESULT_3\": \"\",\n \"IVR_RESULT_4\": \"\",\n \"attempt_num\": 1,\n \"callerid\": \"2933958\",\n \"destination\": \"17420000000\",\n \"display_name\": \"17420000000\",\n \"id\": 1234567,\n \"phone_a\": \"17420001122\",\n \"phone_b\": \"17428092817\",\n \"record_url\": \"\",\n \"result_code\": 200,\n \"session_id\": 84611651\n },\n \"headers\": [],\n \"skills\": [],\n \"variables\": {\n \"UTC\": \"3\",\n \"date\": \"2021-05-18 17:26:41\",\n \"name\": \"name\",\n \"next_attempt_interval\": null,\n \"phone\": \"17428092817\"\n }\n },\n \"domain_name\": \"Your account name\"\n },\n \"hash\": \"ed8c70572c2085a614c720e3b3e30724\",\n \"type\": \"call_assigned_to_agent\"\n }\n ]\n}\n\nTriggered when: a wrap-up code is assigned to a call.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"8f5806485d8c20490e0a527d7b11125e\",\n \"type\": \"wrap_up_code_set\",\n \"wrap_up_code_set\": {\n \"attempt_num\": 1,\n \"call_id\": 314563211,\n \"callback_id\": 317,\n \"campaign_id\": 3902,\n \"datetime_start\": \"2024-02-15 09:00:04\",\n \"domain_name\": \"abc\",\n \"phone_a\": \"147427651512\",\n \"phone_b\": \"147421110022\",\n \"user_id\": 838,\n \"wrap_up_code\": {\n \"callback_at\": \"2024-02-15 13:20:04\",\n \"id\": 1619,\n \"title\": \"Transfer to sales department\",\n \"type\": \"callback\"\n }\n }\n }\n ]\n}\n\nTriggered when: a call is finished (datetime_end is not empty).
\n.
\nData object:
\n{\n \"callbacks\": [\n {\n \"finished_call\": {\n \"callback_id\": 1,\n \"domain_id\": 3,\n \"domain_name\": \"domain\",\n \"finished_call\": {\n \"id\": 3230,\n \"attempt_num\": 3230,\n \"calllist_item_id\": 5549965,\n \"session_id\": 84611651,\n \"scenario_id\": null,\n \"datetime_start\": \"2023-08-30T16:09:54\",\n \"phone_a\": \"17420000000\",\n \"phone_b\": \"17420000333\",\n \"is_incoming\": false, \n \"call_result_code\": 200,\n \"duration\": 36,\n \"record_url\": \"\",\n \"call_data\": \"\",\n \"call_status\": \"\",\n \"recalc\": true,\n \"campaign_id\": null,\n \"processing\": false,\n \"scenario_version_id\": null,\n \"completion_code\": null,\n \"agent_campaign_id\": 25,\n \"agent_campaign_list_item_id\": 25,\n \"dialing_time\": 10,\n \"user_id\": 2,\n \"tags\": [\n {\n \"id\": 637,\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Customer issues\",\n \"tag_name\": \"Complaints\"\n },\n {\n \"id\": 640,\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Goods return\",\n \"tag_name\": \"Returns\"\n },\n {\n \"id\": 642,\n \"tag_color\": \"--orange_10\",\n \"tag_description\": \"VIP customer\",\n \"tag_name\": \"Synenergy\"\n }\n ],\n \"topics\": [\n {\n \"created_at\": \"2023-08-30T16:10:39\",\n \"created_by\": 1209,\n \"id\": 2031,\n \"path\": [\n \"Middle East\",\n \"India\",\n \"Bangalore\"\n ],\n \"topic_id\": 1266,\n \"topic_set_id\": 32,\n \"topic_name\": \"Asian customers\",\n \"path\": \"\",\n \"created_by\": 12,\n \"created_at\": \"\",\n }\n ],\n \"wrap_up_code\": null\n }\n ],\n \"domain_id\": 21,\n \"domain_name\": \"Your account name\",\n \"partner_id\": 0\n },\n \"type\": \"finished_call\"\n }\n }\n\nTriggered when: post-call activities are completed (after service is finished manually by an agent or the after service time limit is reached).
\n.
\nData object:
\n \"callbacks\": [\n {\n \"call_finalized\": {\n \"call_finalized\": {\n \"agent_campaign\": {\n \"id\": 52,\n \"title\": \"Sales and discounts\",\n \"status\": \"ongoing\",\n \"deleted\": false\n },\n \"attempt_num\": 1,\n \"attempt_result\": null,\n \"call_data\": \"\",\n \"call_result_code\": 200,\n \"call_status\": \"false\",\n \"callback_at\": \"2025-08-30T16:09:54\",\n \"calllist_item_id\": 17420000333,\n \"campaign_id\": 12345,\n \"comments\": [],\n \"completion_code\": \"Call_Answered\",\n \"datetime_start\": \"2025-08-30T16:09:54\",\n \"dialing_time\": 7,\n \"domain_id\": 982,\n \"duration\": 36,\n \"id\": 14482386,\n \"is_incoming\": true,\n \"log_path\": \"https://manage.voximplant.com/logs/26599379/8659346/10342420\",\n \"phone_a\": \"17420000000\",\n \"phone_b\": \"17420000333\",\n \"queue\": {\n \"id\": 11,\n \"name\": \"queue_1\",\n \"title\": \"Queue 1\"\n },\n \"record_url\": null,\n \"scenario\": {\n \"id\": 169,\n \"title\": \"Customer research\",\n \"scenario_type\": 2,\n \"deleted\": false\n },\n \"scenario_id\": null,\n \"session_id\": 25254505,\n \"tags\": [\n {\n \"id\": 637,\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Customer issues\",\n \"tag_name\": \"Complaints\"\n },\n {\n \"id\": 640,\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Goods return\",\n \"tag_name\": \"Returns\"\n },\n {\n \"id\": 642,\n \"tag_color\": \"--orange_10\",\n \"tag_description\": \"VIP customer\",\n \"tag_name\": \"Synenergy\"\n }\n ],\n \"topics\": [\n {\n \"created_at\": \"2023-08-30T16:10:39\",\n \"created_by\": 1209,\n \"id\": 2031,\n \"path\": [\n \"Middle East\",\n \"India\",\n \"Bangalore\"\n ],\n \"topic_id\": 1266,\n \"topic_set_id\": 32,\n \"topic_name\": \"Asian customers\",\n \"path\": \"\",\n \"created_by\": 12,\n \"created_at\": \"\",\n }\n ],\n \"wrap_up_code\": {\n \"callback_at\": \"2024-02-15 13:20:04\",\n \"id\": 1619,\n \"title\": \"Transfer to sales department\",\n \"type\": \"callback\"\n },\n \"user_group_id\": 2,\n \"user_id\": 4629\n },\n \"callback_id\": 833,\n \"domain_id\": 982,\n \"domain_name\": \"Your domain name\",\n \"partner_id\": 12\n },\n \"hash\": \"e0c9f7cca9ccf3dd5c72aac25fe1c5e9\",\n \"type\": \"call_finalized\"\n }\n ]\n\nTriggered when: a new conversation is started.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f877877860f1bd3308b5fde1f26e17e7\",\n \"chat_started\": {\n \"datetime\":\"2024-03-18 15:40:19\",\n \"conversation_uuid\":\"6095d931-967b-41de-8f66-1cc5c24369ee\",\n \"incoming_request_id\":218,\n \"client_id\":\"296315625\",\n \"client_name\":\"John\",\n \"channel_id\":15,\n \"channel_type\":\"telegram\",\n \"conversation_url\":\"https://kit.voximplant.com/history/messages?request_id=218\",\n \"type\": \"chat_started\",\n \"domain_name\":\"Your domain name\",\n \"callback_id\":3\n },\n }\n ]\n}\n\nTriggered when: a chat is assigned to an agent.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f877877860f1bd3308b5fde1f26e17e7\",\n \"chat_assigned_to_agent\": {\n \"datetime\":\"2024-03-18 15:40:19\",\n \"conversation_uuid\":\"6095d931-967b-41de-8f66-1cc5c24369ee\",\n \"incoming_request_id\":218,\n \"user_id\":131,\n \"queue_id\":4,\n \"channel_id\":15,\n \"channel_type\":\"telegram\",\n \"type\":\"chat_assigned_to_agent\",\n \"domain_name\":\"Your domain name\",\n \"callback_id\":3\n },\n }\n ]\n}\n\nTriggered when: a chat is closed (by agent, timeout, function, etc).
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f877877860f1bd3308b5fde1f26e17e7\",\n \"chat_closed\": {\n \"datetime\":\"2024-03-18 15:40:19\",\n \"conversation_uuid\":\"6095d931-967b-41de-8f66-1cc5c24369ee\",\n \"incoming_request_id\":218,\n \"closed_by\":131,\n \"closed_reason\":\"CLOSED_BY_AGENT\",\n \"conversation_url\":\"https://kit.voximplant.com/history/messages?request_id=218\",\n \"topics\":null,\n \"comments\":null,\n \"type\": \"chat_closed\",\n \"domain_name\":\"Your domain name\",\n \"callback_id\":3\n },\n }\n ]\n}\n\nTriggered when: a chat is unassigned.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f877877860f1bd3308b5fde1f26e17e7\",\n \"chat_unassigned\": {\n \"datetime\":\"2024-03-18 15:40:19\",\n \"conversation_uuid\":\"6095d931-967b-41de-8f66-1cc5c24369ee\",\n \"incoming_request_id\":218,\n \"user_id\":null,\n \"queue_id\":4,\n \"channel_id\":15,\n \"channel_type\":\"telegram\",\n \"type\":\"chat_unassigned\",\n \"domain_name\":\"Your domain name\",\n \"callback_id\":3\n },\n }\n ]\n}\n\nTriggered when: a chat is transferred from one agent to another.
\nData object:
\n{\n \"callbacks\": [\n {\n \"hash\": \"f877877860f1bd3308b5fde1f26e17e7\",\n \"chat_transfer\": {\n \"datetime\":\"2024-03-18 15:40:19\",\n \"conversation_uuid\":\"6095d931-967b-41de-8f66-1cc5c24369ee\",\n \"incoming_request_id\":218,\n \"from_user\":131,\n \"to_user\":133,\n \"type\": \"chat_transfer\",\n \"domain_name\":\"Your domain name\",\n \"callback_id\":3\n\n },\n }\n ]\n}\n\n\nString. Required.
\nYour API token.
\n"},{"key":"name","value":"business solutions","description":"String. Required.
\nThe name of the URL address that will receive callbacks.
\n","type":"text"},{"key":"url","value":"https://businesssolutions.com/pro","type":"text","description":"String. Required.
\nThe URL address that will receive callbacks.
\n"},{"key":"salt","value":"qddasdasd4","type":"text","description":"String. Required.
\nThe security salt added to the hash to verify that a callback is received from Voximplant Kit.
\n"},{"key":"callbacks","value":"[\"new_calls\", \"caller_id_changed\"]","description":"JSON array. Required.
\nThe callback types you want to receive to your URL address. See the Available callbacks section.
\n","type":"text"},{"key":"is_enabled","value":"true","description":"Boolean. Required.
\nSpecifies whether a callback is enabled.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/callback/create?domain={{domain}}","description":"Creates a callback subscription.
\nIMPORTANT! The maximum number of endpoints per account to which callbacks can be sent is limited to 5.
\n","urlObject":{"protocol":"https","path":["api","v3","callback","create"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"747f923f-af35-41da-bd59-0ece9be8410e","name":"create","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"name","value":"business solutions","description":"String. Required.\n\nThe name of the URL address that will receive callbacks. ","type":"text"},{"key":"url","value":"https://businesssolutions.com/pro","type":"text","description":"String. Required.\n\nThe URL address that will receive callbacks."},{"key":"salt","value":"qddasdasd4","type":"text","description":"String. Required.\n\nThe security salt added to the hash to verify that a callback is received from Voximplant Kit."},{"key":"callbacks","value":"[\"new_calls\", \"caller_id_changed\"]","description":"JSON array. Required.\n\nThe callback types you want to receive to your URL address. See the Available callbacks section.","type":"text"},{"key":"is_enabled","value":"true","description":"Boolean. Required.\n\nSpecifies whether a callback is enabled.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/callback/create?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","callback","create"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 24 Aug 2023 09:39:50 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Kit-Request-Id","value":"70763360bfbb61b4bd97ca10e09bd323"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 34,\n \"domain_id\": 169,\n \"name\": \"business solutions\",\n \"url\": \"https://businesssolutions.com/pro\",\n \"salt\": \"qddasdasd4\",\n \"callbacks\": [\n \"new_calls\",\n \"caller_id_changed\"\n ],\n \"is_enabled\": true,\n \"create_date\": \"2023-08-24 09:39:50\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null\n }\n}"}],"_postman_id":"1051ba9f-baed-46be-ae80-9b4db8ba3774"},{"name":"update","id":"8c7df912-d0b5-4467-a72f-4cd7b1e06eee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"34","type":"text","description":"Integer. Required.
\nThe subscription ID. Use the search method to retrieve the list of callback subscriptions.
\n"},{"key":"name","value":"business solutions","description":"String. Optional.
\nThe name of the URL address that will receive callbacks.
\n","type":"text","disabled":true},{"key":"url","value":"https://businesssolutions.com/pro","type":"text","description":"String. Optional.
\nThe URL address that will receive callbacks.
\n","disabled":true},{"key":"salt","value":"qddasdasd4","type":"text","description":"String. Optional.
\nThe security salt added to the hash to verify that a callback is received from Voximplant Kit.
\n","disabled":true},{"key":"callbacks","value":"[\"new_calls\", \"caller_id_changed\", \"numbers_changed\", \"scenario_created\"]","description":"JSON array. Optional.
\nThe callback types you want to receive to your URL address. See the Available callbacks section.
\n","type":"text"},{"key":"is_enabled","value":"true","description":"Boolean. Optional.
\nSpecifies whether a callback is enabled.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/callback/update?domain={{domain}}","description":"Updates a callback subscription.
\n","urlObject":{"protocol":"https","path":["api","v3","callback","update"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"2829415d-11f6-403c-8dbe-cdf09f5a876e","name":"update","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"34","type":"text","description":"Integer. Required.\n\nThe subscription ID. Use the search method to retrieve the list of callback subscriptions."},{"key":"name","value":"business solutions","description":"String. Optional.\n\nThe name of the URL address that will receive callbacks. ","type":"text","disabled":true},{"key":"url","value":"https://businesssolutions.com/pro","type":"text","description":"String. Optional.\n\nThe URL address that will receive callbacks.","disabled":true},{"key":"salt","value":"qddasdasd4","type":"text","description":"String. Optional.\n\nThe security salt added to the hash to verify that a callback is received from Voximplant Kit.","disabled":true},{"key":"callbacks","value":"[\"new_calls\", \"caller_id_changed\", \"numbers_changed\", \"scenario_created\"]","description":"JSON array. Optional.\n\nThe callback types you want to receive to your URL address. See the Available callbacks section.","type":"text"},{"key":"is_enabled","value":"true","description":"Boolean. Optional.\n\nSpecifies whether a callback is enabled.","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/callback/update?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","callback","update"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 24 Aug 2023 09:42:19 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Vary","value":"Accept"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Kit-Request-Id","value":"4577a0f6e9eedfc7a5a621a0cc1d568f"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 34,\n \"domain_id\": 169,\n \"name\": \"business solutions\",\n \"url\": \"https://businesssolutions.com/pro\",\n \"salt\": \"qddasdasd4\",\n \"callbacks\": [\n \"new_calls\",\n \"caller_id_changed\",\n \"numbers_changed\",\n \"scenario_created\"\n ],\n \"is_enabled\": true,\n \"create_date\": \"2023-08-24 09:39:50\",\n \"created_by\": 1721,\n \"edit_date\": \"2023-08-24 09:42:19\",\n \"edited_by\": 1721\n }\n}"}],"_postman_id":"8c7df912-d0b5-4467-a72f-4cd7b1e06eee"},{"name":"search","id":"b18d0dc6-4cc6-427d-8442-2aa6de990b09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"9","type":"text","description":"Integer. Optional.
\nThe particular subscription ID to filter.
\n","disabled":true},{"key":"name","value":"","description":"String. Optional.
\nThe name of the URL address that receives callbacks.
\n","type":"text","disabled":true},{"key":"url","value":"","type":"text","description":"String. Optional.
\nThe URL address that receives callbacks.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/callback/search?domain={{domain}}","description":"Retrieves a list of callback subscriptions.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","callback","search"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"65f6a9f5-4379-4a7e-a024-2e85c21fedc6","name":"search","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"","type":"text","description":"Integer. Optional.\n\nThe particular subscription ID to filter.","disabled":true},{"key":"name","value":"","description":"String. Optional.\n\nThe name of the URL address that receives callbacks. ","type":"text","disabled":true},{"key":"url","value":"","type":"text","description":"String. Optional.\n\nThe URL address that receives callbacks.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/callback/search?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","callback","search"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 24 Aug 2023 09:42:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"53","type":"text","description":"Integer. Required.
\nThe subscription ID. Use the search method to retrieve the list of callback subscriptions.
\n"}]},"url":"https://{{host}}/api/v3/callback/delete?domain={{domain}}","description":"Deletes a callback subscription.
\n","urlObject":{"protocol":"https","path":["api","v3","callback","delete"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"3c3bf11d-4efc-43ea-8c53-d2bc479eedec","name":"delete","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"53","type":"text","description":"Integer. Required.\n\nThe subscription ID. Use the search method to retrieve the list of callback subscriptions."}]},"url":{"raw":"https://{{host}}/api/v3/callback/delete?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","callback","delete"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 24 Aug 2023 09:35:24 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Vary","value":"Accept"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"08c248ab267eba1e72393030b019c047"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"379cd7f7-e5a5-4b0a-9ec5-7f0f33bd2432"}],"id":"3b49fdea-d388-497c-acaf-99bf0e0cef66","description":"This folder contains actions you may need to create and manage callback subscriptions.
\nHTTP callbacks allow you to get important notifications without frequently sending HTTP requests from your backend to Voximplant Kit.
\nTo get a notification when a certain event occurs in Voximplant Kit (a scenario is changed, a call is assigned to an agent, etc.), you need to subscribe to a certain callback (see below) and an HTTP POST request will be sent to your backend server with the \"Content-Type: application/json\" header and a JSON object in the request body (raw).
INFORMATION! If a callback fails, Voximplant Kit will attempt to resend it up to 3 times at 5-minute intervals.
\nCallback structure:
\n{\n \"callbacks\": []Callback{\n \"hash\": hash(salt, domainName, callbackName),\n \"type\": callbackName,\n callbackName: data,\n }\n}\n\nhash is an md5 encoded string used to verify the expected sender (Voximplant Kit). The security hash is created as follows: hash = md5(Salt + domainName + callbackName). Example: 50c5fe2290cd7409b37e673b8b05e495,
\ntype is a callback type that determines which properties contain data,
\ncallbackName: data is a callback type (callbackName) and callback data (data).
\nIMPORTANT! The maximum number of endpoints per account to which callbacks can be sent is limited to 5.
\n","_postman_id":"3b49fdea-d388-497c-acaf-99bf0e0cef66"},{"name":"callerid","item":[{"name":"searchCallerIDs","id":"186ec383-c9dc-4dc5-aebd-66a90a560f71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"50","type":"text","description":"Integer. Optional.
\nThe particular Caller ID identifier to filter. Use the searchCallerIDs method to retrieve available Caller IDs.
\n"},{"key":"caller_number","value":"","type":"text","description":"String. Optional.
\nThe particular Caller ID phone number to filter.
\n","disabled":true},{"key":"active","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether the Caller ID is active.
\n"},{"key":"with_agent_campaigns","value":"","description":"Boolean. Optional.
\nSpecifies whether the report should include PDS campaigns.
\n","type":"text","disabled":true},{"key":"with_campaigns","value":"","description":"Boolean. Optional.
\nSpecifies whether the report should include automated campaigns.
\n","type":"text","disabled":true},{"key":"with_cc_callerid","value":"","description":"Boolean. Optional.
\nSpecifies whether the report should show if the Caller ID is used in the contact center.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v2/callerid/searchCallerIDs?domain={{domain}}","description":"Retrieves a list of Caller IDs.
\nIf you define specific query parameters, the request returns only the Caller IDs that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v2","callerid","searchCallerIDs"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":""},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"active"}],"variable":[]}},"response":[{"id":"6af0e2ee-4c7d-41c1-bd01-2a2639db7bdc","name":"searchCallerIDs","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"50","type":"text"},{"key":"caller_number","value":"","type":"text","disabled":true},{"key":"active","value":"false","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/callerid/searchCallerIDs?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","callerid","searchCallerIDs"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."},{"key":"sort","value":"active","disabled":true},{"key":"per-page","value":"-13333","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 14:45:33 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4578310ea5722dd07d11ca21fff63480"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"description":"Integer. Required.
\nThe Caller ID identifier. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","key":"caller_id","type":"text","value":"51"}]},"url":"https://{{host}}/api/v2/callerid/deleteCallerID?domain={{domain}}","description":"Deletes a Caller ID.
\n","urlObject":{"protocol":"https","path":["api","v2","callerid","deleteCallerID"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"fdb5c0d5-a896-48c0-b514-507afb3182fa","name":"deleteCallerID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"caller_id","value":"51","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/callerid/deleteCallerID?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","callerid","deleteCallerID"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 14:57:52 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"17c6f9b78e540493a0ebbc50beddbcfc"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"7185951b-1d6e-43b0-a948-cbcbcd089324"}],"id":"22e6ba80-2b64-4dbc-ad3e-4e5de048c280","description":"This folder contains actions you may need to manage Caller IDs.
\nA Caller ID is a custom phone number you add and verify in Voximplant Kit.
\n","_postman_id":"22e6ba80-2b64-4dbc-ad3e-4e5de048c280"},{"name":"calls","item":[{"name":"bindTags","id":"4c38a7c7-8e9d-48a3-a5b2-5d770497237e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"call_id","value":"10162980","type":"text","description":"Integer. Required.
\nThe call ID.
\n"},{"key":"tags","value":"[205]","type":"text","description":"Integer array. Required.
\nThe tag IDs you want to add.
\n"}]},"url":"https://{{host}}/api/v3/calls/bindTags?domain={{domain}}","description":"Binds tags to a call.
\nThe call tagging feature allows you to assign tags to conversations based on certain properties, such as call duration, conversation content, or customer priority.
\n","urlObject":{"protocol":"https","path":["api","v3","calls","bindTags"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c9bd9ed3-9461-4949-a4dc-6fb14ab9d39e","name":"bindTags","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your API token."},{"key":"call_id","value":"10162980","type":"text","description":"Call ID. Required, integer."},{"key":"tags","value":"[205]","type":"text","description":"Tags you want to add to the call. Required, integer array | tag ids."}]},"url":{"raw":"https://{{host}}/api/v3/calls/bindTags?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","calls","bindTags"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 13:31:32 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"e341e3cbfd62df595294c5660e00bad6"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"4c38a7c7-8e9d-48a3-a5b2-5d770497237e"},{"name":"bindTopics","id":"4ef6bcb7-90b8-4105-8a2f-bea414752f16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"call_id","value":"2864686","description":"Integer. Required.
\nThe call ID.
\n"},{"type":"text","key":"topics","value":"[112,113]","description":"Integer array. Required.
\nThe topic IDs you want to add.
\n"}]},"url":"https://{{host}}/api/v3/calls/bindTopics?domain={{domain}}","description":"Binds topics to a call.
\nA topic is similar to a tag; it helps you classify customer requests, for example, Central region, Technical support, Customer service department. Topics are grouped into topic sets. A topic set can include individual topics and topics nested in a hierarchical order. Each topic in a set can have up to 5 nesting levels.
\n","urlObject":{"protocol":"https","path":["api","v3","calls","bindTopics"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"a43b2b4e-2eaa-4fbb-a538-e10d9d9f7982","name":"bindTopics","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"Your API token."},{"type":"text","key":"call_id","value":"2864686","description":"Call ID. Required, integer."},{"type":"text","key":"topics","value":"[112,113]","description":"Topics you want to bind to a call. Required, integer array | topics ids."}]},"url":{"raw":"https://{{host}}/api/v3/calls/bindTopics?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","calls","bindTopics"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 22 Mar 2023 13:39:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"251e47befaa5d983e5e88f87ff1e2ca3"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"4ef6bcb7-90b8-4105-8a2f-bea414752f16"}],"id":"1c3b7903-9065-4d53-a027-bf0d0abc1708","description":"This folder contains actions you may need to add topics and tags to calls.
\n","_postman_id":"1c3b7903-9065-4d53-a027-bf0d0abc1708"},{"name":"campaigns - dialer 2.0","item":[{"name":"Methods to update campaign status","item":[{"name":"schedule","id":"075f9ed3-22cd-4a83-8c5d-c8f818d8e8a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1590","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to schedule. Use the search method to retrieve the list of available campaign IDs.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/schedule?domain={{domain}}&access_token={{access_token}}","description":"Schedules an outbound campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","schedule"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"29bdca2d-05dc-4e99-bf32-8ce4588874d0","name":"schedule","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"1590","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to schedule. Use the search method to retrieve the list of available campaign IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/schedule?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","schedule"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"075f9ed3-22cd-4a83-8c5d-c8f818d8e8a1"},{"name":"start","id":"714dd303-784d-4187-9d42-dbc5a2aa217e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to start. Use the search method to retrieve the list of available campaign IDs.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/start?domain={{domain}}&access_token={{access_token}}","description":"Starts an outbound campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","start"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"a691441c-017d-4442-a8ca-8206c519482b","name":"start","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to start. Use the search method to retrieve the list of available campaign IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/start?access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","start"],"query":[{"key":"access_token","value":"{{access_token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"714dd303-784d-4187-9d42-dbc5a2aa217e"},{"name":"resume","id":"e80f2ddc-a85e-4b91-8ce1-ae5b08118da6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to resume. Use the search method to retrieve the list of available campaign IDs.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/resume?domain={{domain}}&access_token={{access_token}}","description":"Resumes an outbound campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","resume"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"904cd6b3-2902-4ef2-915d-a553b9b5bcc0","name":"resume","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to resume. Use the search method to retrieve the list of available campaign IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/resume?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","resume"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"e80f2ddc-a85e-4b91-8ce1-ae5b08118da6"},{"name":"stop","id":"51b1ec83-9648-4e49-9039-d9c6881ae60e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to stop. Use the search method to retrieve the list of available campaign IDs.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/stop?domain={{domain}}&access_token={{access_token}}","description":"Stops an outgoing campaign and sets its status to completed.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","stop"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"d22cf4eb-5e55-4598-9da1-50f4b105ed8d","name":"stop","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to stop. Use the search method to retrieve the list of available campaign IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/stop?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","stop"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"51b1ec83-9648-4e49-9039-d9c6881ae60e"},{"name":"draft","id":"ac8e0d0a-37f0-4022-8e92-af6dcb43885c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to revert to a draft. Use the search method to retrieve the list of available campaign IDs.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/draft?domain={{domain}}&access_token={{access_token}}","description":"Reverts an outbound campaign to a draft.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","draft"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"81ce192d-40d9-435a-86e7-0e0dfd4c8d94","name":"draft","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to revert to draft. Use the search method to retrieve the list of available campaign IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/draft?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","draft"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"ac8e0d0a-37f0-4022-8e92-af6dcb43885c"}],"id":"324c5dc3-05d0-40f9-ab5e-45ed245d81f2","description":"The folder contains actions you may need to manage the campaign status.
\n","_postman_id":"324c5dc3-05d0-40f9-ab5e-45ed245d81f2"},{"name":"create","event":[{"listen":"prerequest","script":{"id":"b7fcfc8d-37cf-4fe3-b9da-395221ab1032","exec":["var moment = require('moment');","afterTenDays = moment().add(10, 'days');","","pm.environment.set('currentDate', moment().format((\"YYYY-MM-DD hh:mm:ss\")));","pm.environment.set('afterTenDays', afterTenDays.format((\"YYYY-MM-DD hh:mm:ss\")));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f2b79098-9e8c-448e-8257-49ca6bab4f71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"test","type":"text","description":"String. Required.
\nThe campaign name. The maximum name length is 40 characters.
\n"},{"key":"planned_date_start","value":"2024-09-24 13:27:18","type":"text","description":"String. Optional.
\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n"},{"key":"planned_date_end","value":"2023-10-04 10:50:00","type":"text","description":"String. Optional.
\nThe date and time when the campaign should stop calling customers. If not specified, the campaign keeps on placing calls until it reaches the limit of attempts on each phone number.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n"},{"key":"max_lines","value":"5","type":"text","description":"Integer. Required.
\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account.
\n"},{"key":"scenario_id","value":"5384","type":"text","description":"Integer. Required.
\nThe scenario ID that determines the campaign flow. Use the searchScenarios method to retrieve the list of available scenarios.
\n"},{"key":"region","value":"europe","type":"text","description":"String. Required.
\nThe region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. The options are: usa|europe|south_america|singapore|russia|kazakhstan.
\n"},{"key":"max_attempts","value":"140","type":"text","description":"Integer. Required.
\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10).
\n"},{"key":"dialing_strategy","value":"[{\"key\": \"phone1\", \"name\": \"Mobile\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}]","type":"text","description":"JSON array. Required.
\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.
\nExample: [{\"key\": \"phone1\", \"name\": \"Mobile\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}].
\n"},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"JSON array. Optional. Nullable.
\nThe time during which the campaign should make calls. If not specified, the campaign calls customers 24/7.
\nExample: [\"12:00\", \"16:00\"]. Default is null.
\n"},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional. Nullable.
\nThe folder ID to store the campaign.
\n","disabled":true},{"key":"supervisors","value":"[{\"supervisor_id\": 181, \"permission\": \"viewer\"}, {\"supervisor_id\": 182, \"permission\": \"viewer\"}]","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.
\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as supervisors.
\nDefault is [].
\n","disabled":true},{"key":"dnc_list_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional. Nullable.
\nThe DNC list ID(s) to bind to the campaign. The contacts put on those lists do not receive calls within the campaign. Use the searchDncList method to retrieve the list of DNC list IDs.
\nExample: [1, 2, 3].
\n","disabled":true},{"key":"phone_numbers","value":"{\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]}","type":"text","description":"JSON array. Required.
\nIdentifiers of phone numbers to be used as campaign Caller IDs (own, rented, or sip). The system will rotate the added Caller IDs and randomly pick one for each outbound call. The maximum number of phone numbers is 500.
\nThe numbers you indicate must be active. You cannot specify phone_number_ids and/or caller_id_ids together with sip_number_ids in one array. Phone_number_ids and caller_id_ids together are allowed.
\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.
\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}
\n"},{"key":"timezone","value":"Europe/Lisbon","type":"text","description":"String. Optional.
\nCampaign timezone. The parameter is needed if you create a campaign in a timezone different from your account timezone. If you do not pass this parameter, the campaign timezone is the same as your account timezone.
\nExample: Europe/Lisbon.
\n","disabled":true},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.
\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.
\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted.
\nIf you do not pass this parameter, the repeated_attempts value is set.
\n","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/create?domain={{domain}}","description":"Creates an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","create"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"29b3e558-cceb-421a-ac67-2fe9132c158f","name":"create","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"title","value":"My campaign","type":"text","description":"String. Required.\n\nYour API token."},{"key":"planned_date_start","value":"","type":"text","description":"String. Required.\n\nThe campaign name. The maximum name length is 40 characters. "},{"key":"planned_date_end","value":"","type":"text","description":"String. Optional.\n\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign. \n\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null."},{"key":"max_lines","value":"10","type":"text","description":"String. Optional.\n\nThe date and time when the campaign should stop calling customers. If not specified, the campaign keeps on placing calls until it reaches the limit of attempts on each phone number.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null."},{"key":"dialing_strategy","value":"[{\"id\":1,\"key\":\"phone1\",\"name\":\"Телефон 1\",\"dial_up_time_sec\":15,\"interval_min\":[],\"max_attempts\":1}]","type":"text","description":"Integer. Required.\n\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account."},{"key":"working_time[0]","value":"10:00","type":"text","description":"Integer. Required.\n\nThe scenario ID that determines the campaign flow. Use the searchScenarios method to retrieve the list of available scenarios."},{"key":"working_time[1]","value":"19:00","type":"text","description":"String. Required.\n\nThe region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. The options are: usa|europe|south_america|singapore|russia|kazakhstan."},{"key":"supervisors","value":"[]","type":"text","description":"Integer. Required.\n\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10)."},{"key":"phone_numbers","value":"{\"phone_number_ids\":[1126]}","type":"text","description":"JSON array. Required.\n\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.\n\nExample: [{\"name\": \"phone 1\", \"max_attempts\": 3, \"dial_up_time_sec\": 15, \"interval_min\": [3, 4]}]."},{"key":"dnc_list_ids","value":"[]","type":"text","description":"JSON array. Optional. Nullable.\n\nThe time during which the campaign should make calls. If not specified, the campaign calls customers 24/7.\n\nExample: [\"12:00\", \"16:00\"]. Default is null."},{"key":"region","value":"europe","type":"text","description":"Integer. Optional. Nullable.\n\nThe folder ID to store the campaign."},{"key":"scenario_id","value":"8797","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.\n\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as supervisors.\n\nDefault is []."},{"key":"max_attempts","value":"10","type":"text","description":"Integer array. Optional. Nullable.\n\nThe DNC list ID(s) to bind to the campaign. The contacts put on those lists do not receive calls within the campaign. Use the searchDncList method to retrieve the list of DNC list IDs.\n\nExample: [1, 2, 3]."},{"key":"timezone","value":"","type":"text","description":"JSON array. Required.\n\nIdentifiers of phone numbers to be used as campaign Caller IDs (own, rented, or sip). The system will rotate the added Caller IDs and randomly pick one for each outbound call. The maximum number of phone numbers is 500.\n\nThe numbers you indicate must be active. You cannot specify phone_number_ids and/or caller_id_ids together with sip_number_ids in one array. Phone_number_ids and caller_id_ids together are allowed.\n\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.\n\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}\n"},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.\n\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.\n\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted. \n\nIf you do not pass this parameter, the repeated_attempts value is set.","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/create?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","create"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 3540,\n \"title\": \"My campaign\",\n \"status\": \"draft\",\n \"folder_id\": null,\n \"scenario_id\": 8797,\n \"planned_date_start\": null,\n \"planned_date_end\": null,\n \"date_start\": null,\n \"date_end\": null,\n \"working_time\": [\n \"10:00\",\n \"19:00\"\n ],\n \"max_attempts\": 10,\n \"max_lines\": 10,\n \"vox_call_list_id\": 3320,\n \"create_date\": \"2025-09-19 15:03:06\",\n \"created_by\": 4651,\n \"edit_date\": null,\n \"edited_by\": null,\n \"timezone\": \"Europe/Lisbon\",\n \"region\": \"europe\",\n \"dialing_strategy\": [\n {\n \"name\": \"Mobile\",\n \"max_attempts\": 1,\n \"dial_up_time_sec\": 15,\n \"interval_min\": [],\n \"key\": \"phone1\"\n }\n ],\n \"dnc_lists\": [],\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"id\": 1126,\n \"phone_number_active\": true,\n \"phone_number\": \"47421110000\"\n }\n ]\n },\n \"type\": \"automated\",\n \"mode\": null,\n \"predictive_mode\": null,\n \"abandonment_rate\": null,\n \"agent_busy_factor\": null,\n \"task_multiplier\": null,\n \"settings\": null,\n \"use_tags\": true,\n \"use_topics\": true,\n \"topics_set_id\": null,\n \"wrap_up_codes_set_id\": null,\n \"wrap_up_dnc_list_id\": null,\n \"scripting_scenario_id\": null,\n \"use_wrap_up_codes\": false,\n \"user_ids\": [],\n \"task_priority_strategy\": \"repeated_attempts\",\n \"queue\": null\n }\n}"}],"_postman_id":"f2b79098-9e8c-448e-8257-49ca6bab4f71"},{"name":"delete","id":"b7fbefc3-b901-4994-affe-4761ace7ed1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"9","type":"text","description":"Integer. Required.\nID of the campaign to delete.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/delete?domain={{domain}}&access_token={{access_token}}","description":"Deletes an outbound campaign.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","delete"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"92b396be-5bbf-4554-a786-146edab208b8","name":"Campaign is successfully deleted","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"9","type":"text","description":"Integer. Required.\nID of the campaign to delete."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/delete?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","delete"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\nYour API access token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"b7fbefc3-b901-4994-affe-4761ace7ed1d"},{"name":"search","id":"ee0403b4-56b3-4cdc-977a-58f52383ddad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.
\nThe particular campaign ID(s) to filter.
\n","disabled":true},{"key":"statuses","value":"[\"ongoing\", \"completed\"]","type":"text","description":"Array. Optional.
\nCampaign status(es). The options are [\"resume\", \"draft\", \"ongoing\", \"paused\", \"completed\", \"scheduled\"].
\n","disabled":true},{"key":"from","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.
\nThe response will include campaigns launched from the specified date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss.
\n","disabled":true},{"key":"to","value":"2024-03-15 17:20:00","type":"text","description":"String. Optional.
\nThe response will include campaigns launched till the specified date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss.
\n","disabled":true},{"key":"folder_id","value":"1","type":"text","description":"Integer. Optional.
\nThe particular campaign folder ID.
\n","disabled":true},{"key":"title","value":"example","type":"text","description":"String. Optional.
\nThe particular campaign name to filter. The maxvalue is 255.
\n","disabled":true},{"key":"with_phone_numbers","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include phone numbers used as campaign Caller IDs.
\nThe default setting is false.
\n","type":"text"},{"key":"with_dnc_lists","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include DNC lists bound to the campaign.
\nThe default setting is false.
\n","type":"text"},{"key":"with_supervisors","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include campaign supervisors.
\nThe default setting is false.
\n","type":"text"},{"key":"created_from","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.
\nThe response will include campaigns created from the specified date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss.
\n","disabled":true},{"key":"created_to","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.
\nThe response will include campaigns created till the specified date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss.
\n","disabled":true},{"key":"completed_from","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.
\nThe response will include campaigns completed from the specified date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss.
\n","disabled":true},{"key":"completed_to","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.
\nThe response will include campaigns completed till the specified date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss.
\n","disabled":true},{"key":"with_users","value":"false","description":"Boolean or integer. Optional.
\nSpecifies whether the response should include users. The options are true|false. The default setting is false.
\n","type":"text","uuid":"45dff9f9-c4a5-455f-98f6-8a726aacb2a2","disabled":true},{"key":"type","value":"[\"operator\"]","description":"Array. Optional.
\nCampaign type(s) the response should return. The options are [\"automated\", \"operator\"].\nThe default value is [\"operator\"].
\n","type":"text","uuid":"67c998d4-eeef-4e7e-a6ca-2add13cd45c4","disabled":true},{"key":"with_queue","value":"false","description":"Boolean. Optional.
\nSpecifies whether the response should include queue information. The options are true|false. The default setting is false.
\n","type":"text","uuid":"3051b30a-cfda-47ca-ba59-a7674b1f2707","disabled":true},{"key":"with_wrap_up_codes_set","value":"","description":"Boolean. Optional.
\nSpecifies whether the response should include wrap-up codes sets. The options are true|false. The default setting is false.
\n","type":"text","uuid":"85783010-27bb-4b49-a0c5-cce93997b04e","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/search?domain={{domain}}","description":"Retrieves a list of outbound campaigns.
\nIf you define specific query parameters, the request retrieves only the campaigns that match those parameters.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","search"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"id"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe particular page number to include in the report.
\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"1"}],"variable":[]}},"response":[{"id":"9a17ef5d-f696-4c18-8797-c81abb478bf4","name":"search","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.\n\nThe particular campaign ID(s) to filter.","disabled":true},{"key":"statuses","value":"[\"ongoing\", \"completed\"]","type":"text","description":"Array. Optional.\n\nCampaign status(es). The options are [\"resume\", \"draft\", \"ongoing\", \"paused\", \"completed\", \"scheduled\"].","disabled":true},{"key":"from","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional. ДИМА ПОСМОТРИ ПЛИЗ???\n\n \nThe supported format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"to","value":"2024-03-15 17:20:00","type":"text","description":"String. Optional. ДИМА ПОСМОТРИ ПЛИЗ???\n\nThe supported format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"folder_id","value":"1","type":"text","description":"Integer. Optional.\n\nThe particular campaign folder ID.","disabled":true},{"key":"title","value":"example","type":"text","description":"String. Optional.\n\nThe particular campaign name to filter. The maxvalue is 255.","disabled":true},{"key":"with_phone_numbers","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report should include phone numbers used as campaign Caller IDs.\n\nThe default setting is false.","type":"text"},{"key":"with_dnc_lists","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report should include DNC lists bound to the campaign.\n\nThe default setting is false.","type":"text","disabled":true},{"key":"with_supervisors","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report should include campaign supervisors.\n\nThe default setting is false.","type":"text"},{"key":"created_from","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.\n\nThe response will include campaigns created from the specified date and time.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"created_to","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.\n\nThe response will include campaigns created to the specified date and time.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"completed_from","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.\n\nThe response will include campaigns completed from the specified date and time.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"completed_to","value":"2024-03-01 10:30:00","type":"text","description":"String. Optional.\n\nThe response will include campaigns completed to the specified date and time.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"with_users","value":"false","description":"Boolean or integer. Optional.\n\nSpecifies whether the response should include users. The options are true|false. The default setting is false.","type":"text","uuid":"45dff9f9-c4a5-455f-98f6-8a726aacb2a2"},{"key":"type","value":"[\"operator\", \"automated\"]","description":"Array. Optional.\n\nCampaign type(s) the response should return. The options are [\"automated\", \"operator\"].\nThe default value is [\"operator\"].","type":"text","uuid":"67c998d4-eeef-4e7e-a6ca-2add13cd45c4"},{"key":"with_queue","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the response should include queue information. The options are true|false. The default setting is false.","type":"text","uuid":"3051b30a-cfda-47ca-ba59-a7674b1f2707","disabled":true},{"key":"with_wrap_up_codes_set","value":"","description":"Boolean. Optional.\n\nSpecifies whether the response should include wrap-up codes sets. The options are true|false. The default setting is false.","type":"text","uuid":"85783010-27bb-4b49-a0c5-cce93997b04e","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/search?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","search"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"sort","value":"id","description":"String. Optional.\n\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.","type":"text","disabled":true},{"key":"page","value":"2","description":"Integer. Optional.\n\nThe particular page number to include in the report.","type":"text","disabled":true},{"key":"per-page","value":"1","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 3540,\n \"domain_id\": 988,\n \"scenario_id\": 8797,\n \"folder_id\": null,\n \"title\": \"My campaign\",\n \"status\": \"draft\",\n \"max_lines\": 10,\n \"max_attempts\": 10,\n \"dialing_strategy\": [\n {\n \"key\": \"phone1\",\n \"name\": \"Mobile\",\n \"interval_min\": [],\n \"max_attempts\": 1,\n \"dial_up_time_sec\": 15\n }\n ],\n \"working_time\": [\n \"10:00\",\n \"19:00\"\n ],\n \"timezone\": \"Europe/Lisbon\",\n \"region\": \"europe\",\n \"date_start\": null,\n \"date_end\": null,\n \"create_date\": \"2025-09-19 15:03:06\",\n \"created_by\": 4651,\n \"edit_date\": null,\n \"edited_by\": null,\n \"deleted\": false,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"planned_date_start\": null,\n \"planned_date_end\": null,\n \"vox_call_list_id\": 3320,\n \"type\": \"automated\",\n \"mode\": null,\n \"predictive_mode\": null,\n \"abandonment_rate\": null,\n \"agent_busy_factor\": null,\n \"task_multiplier\": null,\n \"settings\": null,\n \"use_tags\": true,\n \"use_topics\": true,\n \"topics_set_id\": null,\n \"use_wrap_up_codes\": false,\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"phone_number\": \"47421110000\",\n \"phone_number_active\": true,\n \"id\": 1126\n }\n ]\n },\n \"user_ids\": []\n },\n {\n \"id\": 3502,\n \"domain_id\": 988,\n \"scenario_id\": null,\n \"folder_id\": null,\n \"title\": \"PDS\",\n \"status\": \"draft\",\n \"max_lines\": 12,\n \"max_attempts\": 10,\n \"dialing_strategy\": [\n {\n \"key\": \"phone1\",\n \"name\": \"Business\",\n \"interval_min\": [],\n \"max_attempts\": 1,\n \"dial_up_time_sec\": 15\n },\n {\n \"key\": \"phone2\",\n \"name\": \"Private\",\n \"interval_min\": [],\n \"max_attempts\": 1,\n \"dial_up_time_sec\": 15\n }\n ],\n \"working_time\": [\n \"10:00\",\n \"19:00\"\n ],\n \"timezone\": \"Europe/Lisbon\",\n \"region\": \"europe\",\n \"date_start\": \"2025-09-17 13:00:11\",\n \"date_end\": null,\n \"create_date\": \"2025-09-17 12:59:27\",\n \"created_by\": 4651,\n \"edit_date\": \"2025-09-17 13:36:00\",\n \"edited_by\": 4651,\n \"deleted\": false,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"planned_date_start\": null,\n \"planned_date_end\": null,\n \"vox_call_list_id\": 3276,\n \"type\": \"operator\",\n \"mode\": \"predictive\",\n \"predictive_mode\": \"abandon_rate\",\n \"abandonment_rate\": 3,\n \"agent_busy_factor\": 1,\n \"task_multiplier\": \"1\",\n \"settings\": {\n \"client_waiting_media_id\": null,\n \"outbound_call_recording\": {\n \"mode\": \"stereo\",\n \"enabled\": true,\n \"notification\": {\n \"type\": \"none\",\n \"media_id\": null,\n \"tts_text\": null,\n \"tts_voice\": null,\n \"tts_language\": null\n },\n \"storage_duration\": \"DEFAULT\"\n },\n \"voicemail_detection_model\": null,\n \"voicemail_detection_enabled\": false,\n \"client_waiting_media_enabled\": false,\n \"voicemail_detection_timeout_sec\": null,\n \"voicemail_detection_timeout_continue_call\": true\n },\n \"use_tags\": false,\n \"use_topics\": false,\n \"topics_set_id\": null,\n \"use_wrap_up_codes\": false,\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"phone_number\": \"47421110000\",\n \"phone_number_active\": true,\n \"id\": 1126\n }\n ]\n },\n \"user_ids\": []\n },\n {\n \"id\": 3376,\n \"domain_id\": 988,\n \"scenario_id\": 8797,\n \"folder_id\": null,\n \"title\": \"Campaigns\",\n \"status\": \"ongoing\",\n \"max_lines\": 10,\n \"max_attempts\": 10,\n \"dialing_strategy\": [\n {\n \"key\": \"phone1\",\n \"name\": \"Mobile\",\n \"interval_min\": [],\n \"max_attempts\": 1,\n \"dial_up_time_sec\": 15\n }\n ],\n \"working_time\": [\n \"10:00\",\n \"19:00\"\n ],\n \"timezone\": \"Europe/Lisbon\",\n \"region\": \"europe\",\n \"date_start\": \"2025-09-12 06:27:02\",\n \"date_end\": \"2025-09-10 14:15:09\",\n \"create_date\": \"2025-09-08 15:11:03\",\n \"created_by\": 4651,\n \"edit_date\": \"2025-09-10 13:45:56\",\n \"edited_by\": 4651,\n \"deleted\": false,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"planned_date_start\": null,\n \"planned_date_end\": null,\n \"vox_call_list_id\": 2692,\n \"type\": \"automated\",\n \"mode\": null,\n \"predictive_mode\": null,\n \"abandonment_rate\": null,\n \"agent_busy_factor\": null,\n \"task_multiplier\": null,\n \"settings\": null,\n \"use_tags\": true,\n \"use_topics\": true,\n \"topics_set_id\": null,\n \"use_wrap_up_codes\": false,\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"phone_number\": \"47421110011\",\n \"phone_number_active\": true,\n \"id\": 1080\n }\n ]\n },\n \"user_ids\": []\n }\n ],\n \"_meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 50\n }\n}"}],"_postman_id":"ee0403b4-56b3-4cdc-977a-58f52383ddad"},{"name":"update","event":[{"listen":"prerequest","script":{"id":"4ea43aaf-c3db-4de5-a1d8-a07fad3d59fc","exec":["var moment = require('moment');","afterTenDays = moment().add(10, 'days');","","pm.environment.set('currentDate', moment().format((\"YYYY-MM-DD hh:mm:ss\")));","pm.environment.set('afterTenDays', afterTenDays.format((\"YYYY-MM-DD hh:mm:ss\")));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8378255a-974d-4332-b7aa-a400646fbb2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"33","type":"text","description":"Integer. Required.
\nThe identifier of the automated campaign you want to update. Use the search method to retrieve the list of available campaign IDs.
\n"},{"key":"title","value":"test011","type":"text","description":"String. Optional.
\nThe name of the automated campaign you want to update (1-40 symbols).
\n","disabled":true},{"key":"planned_date_start","value":"2024-09-24 13:27:18","type":"text","description":"String. Optional.
\nThe campaign scheduled end date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"planned_date_end","value":"2023-10-04 10:50:00","type":"text","description":"String. Optional.
\nThe campaign scheduled start date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"max_lines","value":"4","type":"text","description":"Integer. Optional.
\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account.
\n","disabled":true},{"key":"scenario_id","value":"5384","type":"text","description":"Integer. Optional
\nThe scenario ID to bind to the campaign. Use the searchScenarios method to retrieve the list of available scenarios.
\n","disabled":true},{"key":"region","value":"usa","type":"text","description":"String. Optional.
\nThe region to launch the campaign.
\nThe options are: usa|europe|south_america|singapore|russia|kazakhstan.
\n"},{"key":"max_attempts","value":"5","type":"text","description":"Integer. Optional.
\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10).
\n","disabled":true},{"key":"dialing_strategy","value":"[{\"key\": \"phone1\", \"name\": \"Mobile\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}]","type":"text","description":"JSON array. Optional.
\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.
\nExample: [{\"key\": \"phone1\", \"name\": \"Mobile\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}].
\nFor campaigns in the Ongoing, Scheduled, and Paused statuses you CAN edit max_attempts, dial_up_time_sec, and interval_min, but CANNOT add or delete phone numbers or edit their names. This only applies to newly added contacts.
\n"},{"key":"working_time","value":"[\"13:35\", \"22:01\"]","type":"text","description":"JSON array. Optional. Nullable.
\nThe time during which the campaign makes calls.
\n","disabled":true},{"key":"dnc_list_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional. Nullable.
\nThe DNC list ID(s) to bind to the campaign. \nUse the searchDncList method to retrieve the list of DNC list IDs.
\nExample: [1, 2, 3].
\n","disabled":true},{"key":"supervisors","value":"[{\"supervisor_id\": 181, \"permission\": \"viewer\"}, {\"supervisor_id\": 182, \"permission\": \"viewer\"}]","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.
\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs.
\n","disabled":true},{"key":"phone_numbers","value":"{\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]]}","type":"text","description":"JSON array. Optional.
\nIdentifiers of campaign Caller IDs (own, rented, or sip).
\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.
\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}
\n","disabled":true},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional. Nullable.
\nThe folder ID to store the campaign.
\n","disabled":true},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.
\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.
\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted.
\nIf you do not pass this parameter, the repeated_attempts value is set.
\n","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/update?domain={{domain}}","description":"Updates an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","update"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"b1515924-3ad9-4312-9be9-7f9d7c9efc01","name":"update","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json, text/plain, */*"},{"key":"accept-language","value":"ru-RU,ru;q=0.9,en-US;q=0.8,en;q=0.7"},{"key":"content-type","value":"application/x-www-form-urlencoded"},{"key":"origin","value":"https://kit-eu.voximplant.xyz"},{"key":"priority","value":"u=1, i"},{"key":"referer","value":"https://kit-eu.voximplant.xyz/"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"sec-ch-ua","value":"\"Chromium\";v=\"140\", \"Not=A?Brand\";v=\"24\", \"Google Chrome\";v=\"140\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"sec-fetch-dest","value":"empty"},{"key":"sec-fetch-mode","value":"cors"},{"key":"sec-fetch-site","value":"same-site"},{"key":"user-agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.0.0 Safari/537.36"},{"key":"Cookie","value":"_fbp=fb.1.1755184840814.82783133100852330; kit_domain=dlebedev56; _gcl_au=1.1.333682651.1755184840.1477520736.1757945933.1757945933; kit_access_token=013c393325c77fd45e059b770837295066c5c18d29a577d1186b2efbe51f20dc; _gid=GA1.2.1999603116.1758113836; _rdt_uuid=1755184840664.d74b9629-b05a-45c3-a065-2e8bddbbe872; _ga=GA1.2.1641739832.1755184840; _ga_VVEN5SL7X4=GS2.1.s1758294141$o59$g1$t1758294482$j60$l0$h0; ph_phc_6xwKLZWyPNWGd88hzl47JH23aKXRkV2LHMjxMK1bt91_posthog=%7B%22distinct_id%22%3A%224651%22%2C%22%24sesid%22%3A%5B1758294482031%2C%220199627f-65cf-7ce0-b6e1-e455cd474754%22%2C1758294140366%5D%2C%22%24epp%22%3Atrue%7D"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"id","value":"3540"},{"type":"text","key":"title","value":"Тест 1"},{"type":"text","key":"planned_date_start","value":""},{"type":"text","key":"planned_date_end","value":""},{"type":"text","key":"max_lines","value":"30"},{"type":"text","key":"dialing_strategy","value":"[{\"key\":\"phone1\",\"name\":\"Телефон 1\",\"interval_min\":[],\"max_attempts\":1,\"dial_up_time_sec\":15,\"id\":5}]"},{"type":"text","key":"working_time[0]","value":"10:00"},{"type":"text","key":"working_time[1]","value":"19:00"},{"type":"text","key":"supervisors","value":"[]"},{"type":"text","key":"phone_numbers","value":"{\"phone_number_ids\":[1126]}"},{"type":"text","key":"dnc_list_ids","value":"[]"},{"type":"text","key":"region","value":"europe"},{"type":"text","key":"scenario_id","value":"8797"},{"type":"text","key":"max_attempts","value":"10"},{"type":"text","key":"timezone","value":"Europe/Moscow"},{"type":"text","key":"domain_id","value":"988"},{"type":"text","key":"folder_id","value":""},{"type":"text","key":"status","value":"draft"},{"type":"text","key":"date_start","value":""},{"type":"text","key":"date_end","value":""},{"type":"text","key":"create_date","value":"2025-09-19 15:03:06"},{"type":"text","key":"created_by","value":"4651"},{"type":"text","key":"edit_date","value":""},{"type":"text","key":"edited_by","value":""},{"type":"text","key":"deleted","value":"false"},{"type":"text","key":"delete_date","value":""},{"type":"text","key":"deleted_by","value":""},{"type":"text","key":"vox_call_list_id","value":"3320"},{"type":"text","key":"type","value":"automated"},{"type":"text","key":"mode","value":""},{"type":"text","key":"predictive_mode","value":""},{"type":"text","key":"abandonment_rate","value":""},{"type":"text","key":"agent_busy_factor","value":""},{"type":"text","key":"task_multiplier","value":""},{"type":"text","key":"settings","value":""},{"type":"text","key":"use_tags","value":"true"},{"type":"text","key":"use_topics","value":"true"},{"type":"text","key":"topics_set_id","value":""},{"type":"text","key":"use_wrap_up_codes","value":"false"},{"type":"text","key":"queue[id]","value":""},{"type":"text","key":"queue[title]","value":""},{"type":"text","key":"queue[operator_priority_strategy]","value":""},{"type":"text","key":"queue[request_priority_strategy]","value":""},{"type":"text","key":"queue[afterservice_time_limit_enabled]","value":""},{"type":"text","key":"queue[afterservice_time_limit]","value":""},{"type":"text","key":"queue[call_auto_answer]","value":""},{"type":"text","key":"queue[priority]","value":""},{"type":"text","key":"queue[agents_can_decline_calls]","value":""},{"type":"text","key":"queue[agents_can_end_calls]","value":""},{"type":"text","key":"wrap_up_dnc_list","value":""},{"type":"text","key":"wrap_up_codes_set","value":""},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.\n\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.\n\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted. \n","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/update?domain=dlebedev56","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","update"],"query":[{"key":"domain","value":"dlebedev56","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 3540,\n \"title\": \"My campaign\",\n \"status\": \"draft\",\n \"folder_id\": null,\n \"scenario_id\": 8797,\n \"planned_date_start\": null,\n \"planned_date_end\": null,\n \"date_start\": null,\n \"date_end\": null,\n \"working_time\": [\n \"10:00\",\n \"19:00\"\n ],\n \"max_attempts\": 10,\n \"max_lines\": 30,\n \"vox_call_list_id\": 3320,\n \"create_date\": \"2025-09-19 15:03:06\",\n \"created_by\": 4651,\n \"edit_date\": \"2025-09-19 15:08:17\",\n \"edited_by\": 4651,\n \"timezone\": \"Europe/Lisbon\",\n \"region\": \"europe\",\n \"dialing_strategy\": [\n {\n \"name\": \"Mobile\",\n \"max_attempts\": 1,\n \"dial_up_time_sec\": 15,\n \"interval_min\": [],\n \"key\": \"phone1\"\n }\n ],\n \"dnc_lists\": [],\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"id\": 1126,\n \"phone_number_active\": true,\n \"phone_number\": \"47421110000\"\n }\n ]\n },\n \"type\": \"automated\",\n \"mode\": null,\n \"predictive_mode\": null,\n \"abandonment_rate\": null,\n \"agent_busy_factor\": null,\n \"task_multiplier\": null,\n \"settings\": null,\n \"use_tags\": true,\n \"use_topics\": true,\n \"topics_set_id\": null,\n \"wrap_up_codes_set_id\": null,\n \"wrap_up_dnc_list_id\": null,\n \"scripting_scenario_id\": null,\n \"use_wrap_up_codes\": false,\n \"user_ids\": [],\n \"task_priority_strategy\": \"repeated_attempts\",\n \"queue\": null\n }\n}"}],"_postman_id":"8378255a-974d-4332-b7aa-a400646fbb2b"},{"name":"pause","id":"5e638d13-6cc5-4aa8-bba2-04ba5d56bfd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\nID of the campaign whose status you want to change to paused.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/pause?domain={{domain}}&access_token={{access_token}}","description":"Pauses an outbound campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","pause"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.\nYour account name
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.\nYour API access token
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"5a91e4a3-e603-48e8-ad96-a3306628f527","name":"pause","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\nID of the campaign whose status you want to change to paused."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/pause?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","pause"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\nYour account name"},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\nYour API access token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"5e638d13-6cc5-4aa8-bba2-04ba5d56bfd7"},{"name":"searchLists","id":"15a89883-f993-426e-ba76-3b1df45b9c54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"campaign_id","value":"225","type":"text","description":"Integer. Required.
\nThe ID of the campaign whose contact lists the response should return.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/searchLists?domain={{domain}}","description":"Returns outbound campaign (automated/agent) contact lists.
\nIf you define specific parameters, the request returns only the contacts that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","searchLists"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"e8993ac0-1b3d-48f4-af41-751c8aa6eb44","name":"searchLists","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"campaign_id","value":"3540","type":"text","description":"Integer. Required.\n\nThe ID of the campaign whose contact lists the response should return."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/searchLists?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","searchLists"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 4991,\n \"domain_id\": 988,\n \"is_from_api\": false,\n \"file_name\": \"contact_file.xlsx\",\n \"file_size_bytes\": 6408,\n \"file_path\": \"campaigns/3540/1932d8585ea9e297.xlsx\",\n \"status\": \"draft\",\n \"processing_status\": {\n \"processed\": 5,\n \"invalid_phone\": 1,\n \"invalid_timezone\": 0\n },\n \"properties\": [\n {\n \"key\": \"phone1\",\n \"skip\": false,\n \"label\": \"Mobile\",\n \"value\": 0,\n \"fromXls\": false\n },\n {\n \"key\": \"timezone\",\n \"skip\": false,\n \"label\": \"Timezone\",\n \"value\": 2,\n \"fromXls\": false\n }\n ],\n \"tz_autodetection_enabled\": false,\n \"always_autodetect_tz\": false,\n \"on_autodetect_tz_error\": \"exclude\",\n \"default_timezone\": null,\n \"sort_by\": null,\n \"sort_direction\": null,\n \"total_contacts_count\": 6,\n \"completed_contacts_count\": 0,\n \"success_contacts_count\": 0,\n \"failed_contacts_count\": 0,\n \"canceled_contacts_count\": 0,\n \"create_date\": \"2025-09-19 15:09:35\",\n \"created_by\": 4651,\n \"edit_date\": null,\n \"edited_by\": null,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"deleted\": false,\n \"order_num\": 1,\n \"duplicated_total\": null\n }\n ],\n \"_meta\": {\n \"totalCount\": 1,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 50\n }\n}"}],"_postman_id":"15a89883-f993-426e-ba76-3b1df45b9c54"},{"name":"searchContacts","id":"a24ce8dc-6b4a-4463-902a-14be6067b568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"list_id","value":"666","type":"text","description":"Integer. Required.
\nThe ID of the contact list whose contacts the response should return. Use the searchLists method for the list of available contact list IDs.
\n"},{"key":"status","value":"success","type":"text","description":"String. Optional.
\nContact status. The options are: sent, ongoing, paused, cancelled, success, failed, duplicated.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/searchContacts?domain={{domain}}","description":"Returns contacts of a specific contact list.
\nIf you define specific parameters, the request returns only the contacts that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","searchContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"66e058bb-d233-4ae3-9a80-8dda05d181ab","name":"searchContacts","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"list_id","value":"3540","type":"text","description":"Integer. Required.\n\nThe ID of the contact list whose contacts the response should return. Use the searchLists method for the list of available contact list IDs."},{"key":"status","value":"success","type":"text","description":"String. Optional.\n\nContact status. The options are: sent, ongoing, paused, cancelled, success, failed, duplicated.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/searchContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","searchContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 9419780,\n \"phones\": {\n \"phone1\": \"47420001101\"\n },\n \"variables\": [],\n \"status\": \"ongoing\",\n \"attempts_count\": 0,\n \"max_attempts\": 1,\n \"create_date\": \"2025-09-19 15:09:45\",\n \"task_uuid\": \"f2428a8a-00ce-44ae-b414-2d4cbadc5d0d\",\n \"task_priority\": 250001\n },\n {\n \"id\": 9419781,\n \"phones\": {\n \"phone1\": \"47420001102\"\n },\n \"variables\": [],\n \"status\": \"ongoing\",\n \"attempts_count\": 0,\n \"max_attempts\": 1,\n \"create_date\": \"2025-09-19 15:09:45\"\n },\n {\n \"id\": 9419782,\n \"phones\": {\n \"phone1\": \"Phone 1\"\n },\n \"variables\": [],\n \"status\": \"error\",\n \"attempts_count\": 0,\n \"max_attempts\": 0,\n \"create_date\": \"2025-09-19 15:09:45\"\n },\n {\n \"id\": 9419783,\n \"phones\": {\n \"phone1\": \"47420001103\"\n },\n \"variables\": [],\n \"status\": \"ongoing\",\n \"attempts_count\": 0,\n \"max_attempts\": 1,\n \"create_date\": \"2025-09-19 15:09:45\"\n },\n {\n \"id\": 9419784,\n \"phones\": {\n \"phone1\": \"47420001104\"\n },\n \"variables\": [],\n \"status\": \"ongoing\",\n \"attempts_count\": 0,\n \"max_attempts\": 1,\n \"create_date\": \"2025-09-19 15:09:45\"\n },\n {\n \"id\": 9419785,\n \"phones\": {\n \"phone1\": \"47420001105\"\n },\n \"variables\": [],\n \"status\": \"ongoing\",\n \"attempts_count\": 0,\n \"max_attempts\": 1,\n \"create_date\": \"2025-09-19 15:09:45\"\n }\n ],\n \"_meta\": {\n \"totalCount\": 6,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"a24ce8dc-6b4a-4463-902a-14be6067b568"},{"name":"appendContacts","id":"7b55d3a8-5ae9-4367-80eb-6e45ebd38aa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"campaign_id","value":"2024","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to add contacts to. Use the search method to retrieve the list of available outbound campaign IDs.
\n"},{"key":"rows","value":"[\n {\n \"phone1\": \"89278576425\",\n \"timezone\": \"Europe/Lisbon\",\n \"task_priority\": \"1\"\n },\n {\n \"phone1\": \"89278576425\",\n \"timezone\": \"Europe/Lisbon\",\n \"task_priority\": \"2\"\n }\n]\n","type":"text","description":"JSON array. Required.
\nThe contacts you want to add to the campaign contact list. Maximum is 5000.
\nContact row fields:
\nExample: [{\"phone\":\"17478092817\",\"timezone\":\"America/Aruba\", \"task_priority\": \"1\"}].
\nIMPORTANT! The \"rows\" parameter must contain the same set of fields (phone, timezone, etc.) in one API request.
\nCorrect: [{\"phone\":\"17474888510\",\"timezone\":\"America/Aruba\", \"client_id\":\"12345\"}, \n{\"phone\":\"17474880000\",\"timezone\":\"America/NY\", \"client_id\":\"54321\"}]
\nIncorrect: [{\"phone\":\"17474888510\",\"timezone\":\"America/Aruba\"}, {\"phone\":\"17474880000\",\"timezone\":\"America/NY\", \"client_id\":\"54321\"}]
\n"}]},"url":"https://{{host}}/api/v3/campaigns/appendContacts?domain={{domain}}","description":"Adds contacts to an outbound campaign (automated/agent).
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","appendContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"03117f86-1616-4f2a-b0f0-9a287764d880","name":"appendContacts","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"campaign_id","value":"2024","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to add contacts to. Use the search method to retrieve the list of available outbound campaign IDs."},{"key":"rows","value":"[\n {\n \"phone1\": \"89278576425\",\n \"timezone\": \"Europe/Lisbon\",\n \"task_priority\": \"1\"\n },\n {\n \"phone1\": \"89278576425\",\n \"timezone\": \"Europe/Lisbon\",\n \"task_priority\": \"2\"\n }\n]","type":"text","description":"JSON array. Required.\n\nThe contacts you want to add to the campaign contact list. Maximum is 5000. \n\nContact row fields:\n\n- phone (required)\n- timezone (required)\n- scenario_variables (if any)\n- task_priority (optional, 1 — highest, 250,000 — lowest)\n- client_id (optional)\n\nExample: [{\"phone\":\"17478092817\",\"timezone\":\"America/Aruba\", \"task_priority\": \"1\"}].\n\nIMPORTANT! The \"rows\" parameter must contain the same set of fields (phone, timezone, etc.) in one API request.\n\nCorrect: [{\"phone\":\"17474888510\",\"timezone\":\"America/Aruba\", \"client_id\":\"12345\"}, \n{\"phone\":\"17474880000\",\"timezone\":\"America/NY\", \"client_id\":\"54321\"}]\n\nIncorrect: [{\"phone\":\"17474888510\",\"timezone\":\"America/Aruba\"}, {\"phone\":\"17474880000\",\"timezone\":\"America/NY\", \"client_id\":\"54321\"}]"}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/appendContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","appendContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"success_contacts\": 2,\n \"failed_contacts\": 0,\n \"total_contacts\": 2,\n \"invalid_phones\": null,\n \"invalid_tz\": null\n }\n}"}],"_postman_id":"7b55d3a8-5ae9-4367-80eb-6e45ebd38aa9"},{"name":"createAgent","event":[{"listen":"prerequest","script":{"id":"b7fcfc8d-37cf-4fe3-b9da-395221ab1032","exec":["var moment = require('moment');","afterTenDays = moment().add(10, 'days');","","pm.environment.set('currentDate', moment().format((\"YYYY-MM-DD hh:mm:ss\")));","pm.environment.set('afterTenDays', afterTenDays.format((\"YYYY-MM-DD hh:mm:ss\")));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b9adca9b-84d9-4335-adb7-33e90df0fac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"Campaign","type":"text","description":"String. Required.
\nThe campaign name. The maximum name length is 40 characters.
\n"},{"key":"planned_date_start","value":"2025-05-28 12:27:18","type":"text","description":"String. Optional.
\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"planned_date_end","value":"2025-06-28 10:50:00","type":"text","description":"String. Optional.
\nThe date and time when the campaign should stop calling customers. If not specified, the campaign keeps on placing calls until it reaches the limit of attempts on each phone number.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"max_lines","value":"1","type":"text","description":"Integer. Required.
\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account.
\n"},{"key":"region","value":"europe","type":"text","description":"String. Required.
\nThe region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign.
\nThe options are: usa|europe|south_america|singapore|russia|kazakhstan.
\n"},{"key":"max_attempts","value":"10","type":"text","description":"Integer. Required.
\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10).
\n"},{"key":"dialing_strategy","value":"[{\"key\": \"phone1\", \"name\": \"Mobile\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}]","type":"text","description":"JSON array. Required.
\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.
\nExample: [{\"key\": \"phone1\", \"name\": \"Телефон 1\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}].
\n"},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"JSON array. Optional. Nullable.
\nThe time during which the campaign should make calls. If not specified, the campaign calls customers 24/7.
\nExample: [\"12:00\", \"16:00\"]. Default is null.
\n"},{"key":"supervisors","value":"[{\"supervisor_id\": 181, \"permission\": \"viewer\"}, {\"supervisor_id\": 182, \"permission\": \"viewer\"}]","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.
\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as supervisors.
\nDefault is [].
\n","disabled":true},{"key":"dnc_list_ids","value":"[1]","type":"text","description":"Integer array. Optional. Nullable.
\nThe DNC list ID(s) to bind to the campaign. The contacts put on those lists do not receive calls within the campaign. Use the searchDncList method to retrieve the list of DNC list IDs.
\nExample: [1, 2, 3].
\n","disabled":true},{"key":"phone_numbers","value":"{\"phone_number_ids\":[1126]}","type":"text","description":"JSON array. Required.
\nIdentifiers of phone numbers to be used as campaign Caller IDs (own, rented, or sip). The system will rotate the added Caller IDs and randomly pick one for each outbound call. The maximum number of phone numbers is 500.
\nThe numbers you indicate must be active. You cannot specify phone_number_ids and/or caller_id_ids together with sip_number_ids in one array. Phone_number_ids and caller_id_ids together are allowed.
\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.
\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}
\n"},{"key":"priority","value":"1","description":"Integer. Required.
\nThe campaign priority against inbound queues. Available values are from 1 (highest priority) to 10 (lowest priority).
\n","type":"text","uuid":"3a7c4ded-1289-4221-aecf-d0ab50ced6ba"},{"key":"mode","value":"progressive","type":"text","description":"String. Required.
\nThe campaign dialing mode. The optiona are: predictive|progressive.
\nPredictive - The mode is based on statistical analysis of the results of recent dialing attempts. The essence of this mode is that the system knows the average duration of a dialogue between an employee and a customer, the number of agents, dialing time, etc., and makes a call without waiting for an agent to become available.
\nProgressive - The mode is based on analyzing the number of available agents. Dialing starts automatically and, in case of a successful connection, the call is directed to an available agent.
\nString. Required if \"mode\" is set to predictive.
\nSelect how the system should determine the pace of placing calls to agents in predictive campaigns: by Abandon rate or by Busy factor. The options are abandon_rate|agent_busy_factor.
\nAbandon rate - a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100.
\nBusy factor - a parameter that defines the target level of agent occupancy (min. - 1, max. - 100).
\n"},{"key":"abandonment_rate","value":"10","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is abandon_rate.
\nAbandon rate is a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls in predictive campaigns. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100.
\n"},{"key":"agent_busy_factor","value":"10","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is agent_busy_factor.
\nBusy factor is a parameter that defines the target level of agent occupancy in predictive campaigns (min. - 1, max. - 100).
\n","disabled":true},{"key":"task_multiplier","value":"1","type":"text","description":"Float. Required if \"mode\" is set to progressive.
\nThe workload distribution factor that determines the pace of placing calls to each idle agent in progressive campaigns. The minimum value is 1, the maximum is 25. For campaigns with more than 20 agents, the limit is 100.
\n"},{"key":"agents_can_end_calls","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the campaign agents can dend external calls. The default setting is false.
\n"},{"key":"agents_can_decline_calls","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the campaign agents can decline external calls. The default setting is false.
\n"},{"key":"call_auto_answer","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the auto-answer calls feature is enabled for the campaign. When an inbound call comes in, the system automatically connects a customer to an agent. The default setting is false.
\n"},{"key":"voicemail_detection_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the voicemail detection feature is enabled for the campaign. The default setting is false.
\n"},{"key":"voicemail_detection_model","value":"ru","type":"text","description":"String. Required if voicemail_detection_enabled is true.
\nThe voicemail detection model to use in the campaign. \nThe options are 'ru' | 'kz' | 'colombia' | 'br' | 'mx' | 'ph' | 'pe' | 'us' | 'cl' | 'ru_experimental_vm' | 'ru_experimental_human'.
\n"},{"key":"voicemail_detection_timeout_sec","value":"9.5","type":"text","description":"Float. Required if voicemail_detection_enabled is true.
\nThe maximum detection time. Minimum = 1.0, max = 10.0. Can be fractional.
\n"},{"key":"voicemail_detection_timeout_continue_call","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies how the system should behave if it fails to detect whether it reached a live person or voicemail.
\nIf set to \"true\", the call is routed to a campaign agent.
\nIf set to \"false\", the call is terminated.
\nDefault is false.
\n"},{"key":"client_waiting_media_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the system should play an audio recording to a customer while waiting for an agent. When set to false, a customer waits for an agent in silence.
\nDefault is false.
\n","disabled":true},{"key":"client_waiting_media_id","value":"1","type":"text","description":"Integer. Required if client_waiting_media_enabled is true.
\nThe ID of the media file that will be played to a customer while waiting for an agent. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"can_outbound_record","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether outbound call recording is enabled for the campaign. When enabled, the system records all outbound calls and stores the recordings in the Call history section, so that you could listen and download them. The default setting is false.
\nIMPORTANT! In some countries, you are compelled by law to inform the other party that you are recording the call.
\n"},{"key":"outbound_record_notification_type","value":"media","type":"text","description":"String. Required if can_outbound_record is true.
\nThe notification type used to inform a customer that the call is being recorded. The options are none|media|tts. The default value is none.
\n","disabled":true},{"key":"outbound_record_notification_duration","value":"SIXMONTHS","type":"text","description":"String. Required if can_outbound_record is true.
\nThe time during which outbound call recordings are available for listening and downloading in the Call history sections. The options are DEFAULT|SIXMONTHS|ONEYEAR|TWOYEARS|THREEYEARS.
\n","disabled":true},{"key":"notification_media_id","value":"1","type":"text","description":"Integer. Required if can_outbound_record is selected and outbound_record_notification_type is media.
\nThe ID of the media file uploaded for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"tts_language","value":"foo","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech language for outbound call recording notifications.
\nThe following languages are available:
\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft.
\n","disabled":true},{"key":"tts_voice","value":"bar","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech voice for outbound call recording notifications.
\nThe following options are available:
\nBengali (India):
\nEnglish (US):
\nEnglish (GB):
\nEnglish (AU):
\nEnglish (IN):
\nRussian:
\nGerman:
\nFrench:
\nFrench (CA):
\nItalian:
\nJapanese:
\nDutch:
\nTurkish:
\nKorean:
\nSwedish:
\nDanish:
\nSlovak:
\nPortuguese (BR):
\nPortuguese (PT):
\nPolish:
\nUkrainian:
\nVietnamese:
\nFilipino:
\nArabic:
\nChinese (Mandarin):
\nCzech:
\nGreek:
\nFinnish:
\nHindi:
\nHungarian:
\nIndonesian:
\nNorwegian:
\nSpanish (Castilian):
\nSpanish (US):
\nKazakh (Kazakhstan):
\nSpanish (MX):
\nArabic (SA):
\nWelsh (UK):
\nIcelandic:
\nRomanian:
\nArabic:
\nChinese (Mandarin):
\nSpanish (LA):
\nArabic (UAE):
\nArabic (Yemen):
\nBangla (Bangladesh):
\nBulgarian:
\nBurmese (Myanmar):
\nCatalan (Spain):
\nChinese (Cantonese, Traditional):
\nChinese (Taiwanese Mandarin):
\nCroatian:
\nDutch (BE):
\nSpanish (Argentina):
\nNepali (Nepal):
\nEnglish (Canada):
\nEnglish (Hongkong):
\nEnglish (Ireland):
\nEnglish (Kenya):
\nEnglish (New Zeland):
\nEnglish (Nigeria):
\nEnglish (Philippines):
\nEnglish (South Africa):
\nEnglish (Tanzania):
\nFrench (Belgium):
\nFrench (Switzerland):
\nGalician (Spain):
\nGerman (Austria):
\nGerman (Switzerland):
\nGujarati (India):
\nIrish (Ireland):
\nJavanese (Indonesia):
\nKannada (India):
\nKazakh (Kazakhstan):
\nKhmer (Cambodia):
\nLao (Laos):
\nLithuanian (Lithuania):
\nMacedonian (North Macedonia):
\nMalay:
\nMalayalam (India):
\nMaltese (Malta):
\nMarathi (India):
\nPashto (Afghanistan):
\nPersian (Iran):
\nSerbian (Serbia, Cyrillic):
\nSinhala (Sri Lanka):
\nSlovenian:
\nSomali (Somalia):
\nSpanish (Bolivia):
\nSpanish (Chile):
\nSpanish (Costa Rica):
\nSpanish (Cuba):
\nSpanish (Dominican Republic):
\nSpanish (Ecuador):
\nSpanish (El Salvador):
\nSpanish (Equatorial Guinea):
\nSpanish (Guatemala):
\nSpanish (Honduras):
\nSpanish (Nicaragua):
\nSpanish (Panama):
\nSpanish (Paraguay):
\nSpanish (Peru):
\nSpanish (Puerto Rico):
\nSpanish (Uruguay):
\nSpanish (Venezuela):
\nSundanese (Indonesia):
\nSwahili (Tanzania):
\nTamil (India):
\nTamil (Singapore):
\nTamil (Sri Lanka):
\nTelugu (India):
\nThai:
\nUrdu (India):
\nMicrosoft: Gul, Salman (neutral voices)
\nGoogle: Wavenet_A, Wavenet_B, Standard_A, Standard_B
\nUrdu (Pakistan):
\nZulu (South Africa):
\nUzbek:
\nHebrew: (Israel):
\nSpanish (Colombia):
\nEstonian (Estonia):
\nLatvian (Latvia):
\nString. Required if can_outbound_record is selected and outbound_record_notification_type is tts.
\nThe synthesized speech text for outbound call recording notifications.
\n","disabled":true},{"key":"afterservice_time_limit_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the after service time limit is enabled for the campaign. When enabled, the campaign agents have limited time to spend on post-call activities, like making call records, adding contacts, or assigning wrap-up codes. The default setting is false.
\n","disabled":true},{"key":"afterservice_time_limit_sec","value":"10","type":"text","description":"Integer. Required if afterservice_time_limit_enabled is true.
\nThe maximum time the campaign agents can spend on post-call activities (1-600). The default value is 60.
\n","disabled":true},{"key":"use_tags","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether campaign agents can use tags to classy dialogues.
\nDefault is false.
\n","disabled":true},{"key":"use_topics","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether campaign agents can use topics to classy dialogues.
\nDefault is false.
\n","disabled":true},{"key":"topics_set_id","value":"1","type":"text","description":"Integer. Required if use_topics is true.
\nThe topic set assigned to the campaign for dialogue classification. Use the searchTopicSets method to retrieve the list of available topic sets.
\n","disabled":true},{"key":"user_ids","value":"[33223]","type":"text","description":"Integer array. Optional.
\nThe campaign agents' IDs. Use the searchUsers method to retrieve the list of user IDs.
\n"},{"key":"use_wrap_up_codes","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether campaign agents can assign wrap-up codes. You assign a wrap-up codes set to your campaign if you want the campaign agents to label the outcome of their calls after interaction with a customer.
\nDefault is false.
\n"},{"key":"wrap_up_codes_set_id","value":"783","type":"text","description":"Integer. Required if use_wrap_up_codes is true.
\nThe wrap-up codes set ID.
\n"},{"key":"wrap_up_dnc_list_id","value":"1180","type":"text","description":"Integer. Optional.
\nThe DNC list ID to assign to the campaign.
\nIf the wrap-up codes set you attached to the campaign contains the Add to DNC list code, the system prompts you to bind a DNC list.
\nUse the searchDncList method to retrieve available DNC lists.
\n"},{"key":"timezone","value":"Europe/Lisbon","type":"text","description":"String. Optional.
\nCampaign timezone. The parameter is needed if you create a campaign in a timezone different from your account timezone. If you do not pass this parameter, the campaign timezone is the same as your account timezone.
\nExample: Europe/Lisbon.
\n","disabled":true},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional.
\nThe campaign folder ID.
\nYou can store your campaigns in folders or in the root directory (default).
\n","disabled":true},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.
\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.
\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted.
\nIf you do not pass this parameter, the repeated_attempts value is set.
\n","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/createAgent?domain={{domain}}","description":"Creates an agent campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","createAgent"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"ea2b2b3c-1258-4043-84a5-d970ae354d40","name":"createAgent","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"domain","value":"{{domain}}","type":"text","uuid":"75995135-2f9b-41a1-92b1-5e2092c19c0d"},{"key":"title","value":"Test PDS","type":"text","description":"String. Required.\n\nThe campaign name. The maximum name length is 40 characters. "},{"key":"max_attempts","value":"1","type":"text","description":"String. Optional.\n\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null."},{"key":"use_tags","value":"true","type":"text","description":"String. Optional.\n\nThe date and time when the campaign should stop calling customers. If not specified, the campaign keeps on placing calls until it reaches the limit of attempts on each phone number.\n\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null."},{"key":"use_topics","value":"false","type":"text","description":"Integer. Required.\n\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account."},{"key":"interval","value":"60","type":"text","description":"String. Required.\n\nThe region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. \n\nThe options are: usa|europe|south_america|singapore|russia|kazakhstan."},{"key":"working_time","value":"[\"\",\"\"]","type":"text","description":"Integer. Required.\n\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10)."},{"key":"user_ids","value":"[]","type":"text","description":"JSON array. Required.\n\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.\n\nExample: [{\"name\": \"phone 1\", \"max_attempts\": 3, \"dial_up_time_sec\": 15, \"interval_min\": [3, 4]}]."},{"key":"mode","value":"predictive","type":"text","description":"JSON array. Optional. Nullable.\n\nThe time during which the campaign should make calls. If not specified, the campaign calls customers 24/7.\n\nExample: [\"12:00\", \"16:00\"]. Default is null."},{"key":"voicemail_detection_enabled","value":"false","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.\n\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as supervisors.\n\nDefault is []."},{"key":"dial_up_time_sec","value":"40","type":"text","description":"Integer array. Optional. Nullable.\n\nThe DNC list ID(s) to bind to the campaign. The contacts put on those lists do not receive calls within the campaign. Use the searchDncList method to retrieve the list of DNC list IDs.\n\nExample: [1, 2, 3]."},{"key":"afterservice_time_limit_enabled","value":"false","type":"text","description":"JSON array. Required.\n\n\nIdentifiers of phone numbers to be used as campaign Caller IDs (own, rented, or sip). The system will rotate the added Caller IDs and randomly pick one for each outbound call. The maximum number of phone numbers is 500.\n\nThe numbers you indicate must be active. You cannot specify phone_number_ids and/or caller_id_ids together with sip_number_ids in one array. Phone_number_ids and caller_id_ids together are allowed.\n\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.\n\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}"},{"key":"afterservice_time_limit","value":"0","type":"text","description":"String. Required.\n\nThe campaign dialing mode. The optiona are: predictive|progressive.\n\n- Predictive - The mode is based on statistical analysis of the results of recent dialing attempts. The essence of this mode is that the system knows the average duration of a dialogue between an employee and a customer, the number of agents, dialing time, etc., and makes a call without waiting for an agent to become available.\n\n- Progressive - The mode is based on analyzing the number of available agents. Dialing starts automatically and, in case of a successful connection, the call is directed to an available agent."},{"key":"can_outbound_record","value":"false","type":"text","description":"String. Required if \"mode\" is set to predictive.\n\nSelect how the system should determine the pace of placing calls to agents in predictive campaigns: by Abandon rate or by Busy factor. The options are abandon_rate|agent_busy_factor.\n\nAbandon rate - a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100.\n\nBusy factor - a parameter that defines the target level of agent occupancy (min. - 1, max. - 100)."},{"key":"outbound_record_notification_type","value":"none","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is abandon_rate.\n\nAbandon rate is a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls in predictive campaigns. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100."},{"key":"outbound_record_notification_duration","value":"DEFAULT","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is agent_busy_factor.\n\nBusy factor is a parameter that defines the target level of agent occupancy in predictive campaigns (min. - 1, max. - 100)."},{"key":"tts_language","value":"VoiceList.Yandex","type":"text","description":"Float. Required if \"mode\" is set to progressive.\n\nThe workload distribution factor that determines the pace of placing calls to each idle agent in progressive campaigns. The minimum value is 1, the maximum is 15."},{"key":"tts_voice","value":"Neural.ru_RU_alena","type":"text","description":"Boolean. Optional. \n\nSpecifies whether the campaign agents can dend external calls. The default setting is false."},{"key":"tts_text","value":"","type":"text","description":"Boolean. Optional. \n\nSpecifies whether the campaign agents can decline external calls. The default setting is false."},{"key":"properties","value":"[]","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the auto-answer calls feature is enabled for the campaign. When an inbound call comes in, the system automatically connects a customer to an agent. The default setting is false."},{"key":"agents_can_decline_calls","value":"false","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the voicemail detection feature is enabled for the campaign. The default setting is false."},{"key":"agents_can_end_calls","value":"false","type":"text","description":"String. Required if voicemail_detection_enabled is true.\n\nThe voicemail detection model to use in the campaign. \nThe options are 'ru' | 'kz' | 'colombia' | 'br' | 'mx' | 'ph' | 'pe' | 'us' | 'cl' | 'ru_experimental_vm' | 'ru_experimental_human'."},{"key":"call_auto_answer","value":"false","type":"text","description":"Float. Required if voicemail_detection_enabled is true.\n\nThe maximum detection time. Minimum = 1.0, max = 10.0. Can be fractional."},{"key":"dnc_lists","value":"[]","type":"text","description":"Boolean. Optional.\n\nSpecifies how the system should behave if it fails to detect whether it reached a live person or voicemail.\n\nIf set to \"true\", the call is routed to a campaign agent.\n\nIf set to \"false\", the call is terminated.\n\nDefault is false."},{"key":"wrap_up_codes_set_id","value":"","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the system should play an audio recording to a customer while waiting for an agent. When set to false, a customer waits for an agent in silence.\n\nDefault is false."},{"key":"abandonment_rate","value":"3","type":"text","description":"Integer. Required if client_waiting_media_enabled is true.\n\nThe ID of the media file that will be played to a customer while waiting for an agent. Use the searchMedia method to retrieve the list of available media files."},{"key":"task_multiplier","value":"1","type":"text","description":"Boolean. Optional.\n\nSpecifies whether outbound call recording is enabled for the campaign. When enabled, the system records all outbound calls and stores the recordings in the Call history section, so that you could listen and download them. The default setting is false.\n\nIMPORTANT! In some countries, you are compelled by law to inform the other party that you are recording the call."},{"key":"voicemail_detection_model","value":"br","type":"text","description":"String. Required if can_outbound_record is true.\n\nThe notification type used to inform a customer that the call is being recorded. The options are none|media|tts. The default value is none."},{"key":"voicemail_detection_timeout_sec","value":"6.5","type":"text","description":"String. Required if can_outbound_record is true.\n\nThe time during which outbound call recordings are available for listening and downloading in the Call history sections. The options are DEFAULT|SIXMONTHS|ONEYEAR|TWOYEARS|THREEYEARS."},{"key":"supervisors","value":"[{\"permission\":\"viewer\"}]","type":"text","description":"Integer. Required if can_outbound_record is selected and outbound_record_notification_type is media.\n\nThe ID of the media file uploaded for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files."},{"key":"selectedSupervisorsIds","value":"[4673]","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.\n\nThe synthesized speech language for outbound call recording notifications.\n\nThe following languages are available:\n\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft."},{"key":"region_enabled","value":"false","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.\n\nThe synthesized speech voice for outbound call recording notifications.\n\nThe following options are available:\n\nBengali (India):\n \n- Google: Wavenet_A, Wavenet_B (neutral voices), Standard_A, Standard_B (common voices)\n- Microsoft: Tanishaa, Bashkar (neutral voices)\n\nEnglish (US): \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E, Standard_B, Standard_C, Standard_D, Standard_E (common voices), Wavenet_F (neutral voices), Neural2_A, Neural2_C, Neural2_D, Neural2_E, Neural2F, Neural2_G, Neural2_H, Neural2_I, Neural2_J, News_K, News_L, News_M, Studio O, Studio Q, News_N, Journey_O \n- Yandex: Alyss, Nick (common voices)\n- Amazon: Ivy, Joanna, Kendra, Kimberly, Salli, Joey,Justin, Matthew (neutral voices), Joanna, Joey (common voices)\n- IBM: Allison, Emily, Henry, Kevin, Lisa, Michael,Olilia (neutral voices), Allison, Lisa, Michael (common voices)\n- Microsoft: Amber, Ashley, Cora, Elizabeth, Michelle, Monica, Sara, Ana, Brandon, Christopher, Eric, Jacob, Aria, Guy (neutral voices), Ava, Andrew, Emma, Brian\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nEnglish (GB):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices) \n- Amazon: Amy, Emma, Brian (neutral voices), Amy, Brian (common voices)\n- IBM: Kate (neutral voice), Kate (common voice)\n- Microsoft: Sonia, Ryan, Libby Mia (neutral voices)\n\nEnglish (AU):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Nicole, Russel (common voices)\n- Microsoft: William, Natasha (neutral voices)\n\nEnglish (IN):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Wavenet_E, Wavenet_F, Standard_B, Standard_C, Standard_A (common voices), Standard_E, Standard_F\n- Amazon: Aditi (common voice)\n- Microsoft: Prabhat, Neerja (neutral voices)\n\nRussian:\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Yandex: Alena, Filipp (neutral voices), Jane, Omazh, Zahar, Ermil (common voices)\n- Amazon: Maxim, Tatyana (common voices)\n- TBank: Anna, Dima\n- Microsoft: Dariya, Svetlana, Dmitry (neutral voices)\n- SaluteSpeech: Natalia, Boris, Marfa, Taras, Alexandra, Sergey (common voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nGerman: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_E (common voices) \n- Amazon: Marlene, Hans (common voices)\n- IBM: Birgit, Dieter, Erika (neutral voices), Birgit, Dieter (common voices)\n- Microsoft: Conrad, Katja (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nFrench: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_E (common voices), Standard_F, Standard_G\n- Amazon: Celine, Mathieu (common voices)\n- IBM: Renee (neutral voice), Renee (common voice)\n- Microsoft: Henri, Denise (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nFrench (CA): \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Chantal (common voice)\n- Microsoft: Antonie, Jean, Sylvie (neutral voices)\n\nItalian: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Carla, Giorgio (common voices)\n- IBM: Francesca (neutral voice), Francesca (common voice)\n- Microsoft: Isabella, Diego, Elsa (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nJapanese: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Mizuki, Takumi (common voices)\n- IBM: Emi (neutral voice), Emi (common voice)\n- Microsoft: Keita, Nanami (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nDutch: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Lotte, Rubin (common voices)\n- IBM: Emi (neutral voice), Emi (common voice)\n- Microsoft: Fenna, Maarten, Colette (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nTurkish: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Lotte, Rubin (common voices)\n- Yandex: Sila Erkan, Erkan Yavas\n- Amazon: Filiz (common voice)\n- Microsoft: Ahmet, Emel (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nKorean: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices) \n- IBM: Youngmi, Yuna (common voices)\n- Microsoft: InJoon, SunHi (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nSwedish: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Amazon: Astrid (common voice)\n- Microsoft: Sopie, Mattias, Hillevi (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nDanish: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Amazon: Naja, mads (common voices)\n- Microsoft: Jeppe, Christel\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nSlovak: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Viktoria, Lukas (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nPortuguese (BR):\n\n- Google: Wavenet_A (neutral voice), Wavenet_D, Wavenet_E, Standard_A (common voice), Standard_D, Standard_E, Standard_B, Standard_C\n- Amazon: Camila (neutral voice), Viktoria, Ricardo (common voices)\n- IBM: Isabela (neutral voice), Isabela (common voice)\n- Microsoft: Antonio, Francisca (neutral voices)\n- ElevenLabs: Conrado Bueno, ScheilaSMTy, Marcio - Bold & Captivating, Rener, Vinicius Bergamo, Brazilian Dudy, Samuel - Jovem Empreendedor, João Pedro\n\nPortuguese (PT):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Ines, Cristiano (common voices)\n- Microsoft: Raquel, Duarte, Fernanda (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nPolish: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Maja, Jan (common voices)\n- Microsoft: Agnieszka, Marek, Zofia (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nUkrainian: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Polina, Ostap (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nVietnamese: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices) \n- Microsoft: HoaiMy, NamMinh (neutral voices)\n\nFilipino:\n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Blessica, Angelo (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nArabic: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices) \n\nChinese (Mandarin):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices) \n- Microsoft: Xiaochen, Xiaorou, Xiaorou (dialects), Xiaoxiao (multilingual), Xiaoyu, Yunjie, Yunyi\n\nCzech: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Vlasta, Antonin (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nGreek: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Athina, Nestoras (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nFinnish: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Harri, Noora (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nHindi: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Wavenet_E, Wavenet_F, Standard_B, Standard_C, Standard_A (common voices), Standard_E, Standard_F \n- Amazon: Aditi (common voice)\n- Microsoft: Madhur, Swara (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nHungarian:\n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Noemi, Tamas (neutral voices)\n\nIndonesian: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_B, Standard_C, Standard_A (common voices)\n- Microsoft: Gadis, Ardi (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nNorwegian: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Liv (common voice)\n- Microsoft: Pernille, Finn, Iselin (neutral voices)\n\nSpanish (Castilian): \n\n- Google: Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A (common voice), Neural2_A, Neural2_B, Neural2_C, Neural2_D, Neural2_E, Neural2_F, Studio_C, Studio_F \n- Amazon: Conchita, Enrique (common voices)\n- IBM: Enrique, Laura (neutral voices), Enrique, Laura (common voices)\n- Microsoft: Elvira (neutral voice)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will, Cristina Campos, Santiago, Gilfoy, Svea - Spanish Customer Care, Alejandra, Miguel, Carolina Ruiz, Sara Martin - 3, Frankie San Juan, Martin Osborne - 6, Alex, Carolina - Spanish woman, Mauricio, Fran - Fresh & Upbeat, EDGARD, Valeria - Friendly Woman, Julius Professional, Dr. Lozano, Alejandro, Julius Master, Pablo (Vambe AI V2), paco, Didak Leñero\n\nSpanish (US): \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_A, Standard_B, Standard_C (common voices) \n- Amazon: Lupe (neutral voice), Penelope, Miguel (common voices)\n- IBM: Sofia (neutral voice), Sofia (common voice)\n- Microsoft: Alonso (neutral voice)\n\nKazakh (Kazakhstan): \n\n- YandexV3: Amira (common voice)\n\nSpanish (MX):\n\n- Amazon: Mia (common voice)\n- Microsoft: Jorge, Dalia (neutral voices)\n\nArabic (SA): \n\n- Amazon: Zeina (common voice)\n- Microsoft: Hamed, Zariyah (neutral voices)\n\nWelsh (UK): \n\n- Amazon: Gwyneth, Geraint (common voices)\n- Microsoft: Nia, Aled (neutral voices)\n\nIcelandic: \n\n- Amazon: Dora, Carl (common voices)\n- Microsoft: Gudrun, Gunnar (neutral voices)\n\nRomanian: \n\n- Amazon: Carmen (common voice)\n- Microsoft: Alina, Emil (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nArabic: \n\n- IBM: Omar (common voice)\n\nChinese (Mandarin):\n\n- IBM: LiNa, WangWei, ZhangJing (common voices)\n- Microsoft: Xiaochen, Xiaohan, Xiaomo, Xiaoqiu, Xiaorui, Xiaoshuang, Xiaoxuan, Xiaoyan, Yunxi, Xiaoxiao, Xiaoyou, Yunyang, Yunye (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nSpanish (LA): \n\n- IBM: Sofia (neutral voice), Sofia (common voice)\nAfrikaans (South Africa): \n- Microsoft: Adri, Willem (neutral voices)\nAmharic (Ethiopia):\n- Microsoft: Mekdes, Ameha (neutral voices)\nArabic (Algeria): \n- Microsoft: Amina, Izmael (neutral)\nArabic (Bahrein): \n- Microsoft: Laila, Ali (neutral)\nArabic (Egypt):\n- Microsoft: Shakir, Salma (neutral voices)\nArabic (Iraq): \n- Microsoft: Rana, Bassel (neutral voices)\nArabic (Jordan): \n- Microsoft: Sana, Taim (neutral voices)\nArabic (Kuwait): \n- Microsoft: Noura, Fahed (neutral voices)\nArabic (Libya): \n- Microsoft: Iman, Omar (neutral voices)\nArabic (Morocco): \n- Microsoft: Mouna, Jamal (neutral voices)\nArabic (Qatar): \n- Microsoft: Amal, Moaz (neutral voices)\nArabic (Syria):\n- Microsoft: Amany, Laith (neutral voices)\nArabic (Tunisia):\n- Microsoft: Reem, Hedi (neutral voices)\n\nArabic (UAE):\n\n- Microsoft: Fatima, Hamdan (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nArabic (Yemen):\n\n- Microsoft: Maryam, Saleh (neutral voices)\nAzerbaijani (Azerbaijan): \n- Microsoft: Babek, Banu (neutral voices)\n\nBangla (Bangladesh): \n\n- Microsoft: Nabanita, Pradeep (neutral voices)\n\nBulgarian:\n\n- Google: Standard_A\n- Microsoft: Kalina, Borislav\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nBurmese (Myanmar): \n\n- Microsoft: Nilar, Thiha (neutral voices)\n\nCatalan (Spain):\n\n- Microsoft: Joana, Enric, Alba (neutral voices)\n\nChinese (Cantonese, Traditional): \n\n- Microsoft: HiuMaan, WanLung, HiuGaai (neutral voices)\n\nChinese (Taiwanese Mandarin): \n\n- Microsoft: HsiaoChen, YunJhe, HsiaoYu (neutral voices)\n\nCroatian:\n\n- Microsoft: Gabrijela, Srecko (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nDutch (BE): \n\n- Microsoft: Dena, Arnaud (neutral voices)\n\nSpanish (Argentina): \n\n- Microsoft: Elena, Tomas (neutral voices)\n\nNepali (Nepal): \n\n- Microsoft: Sagar, Hemkala (neutral voices)\n\nEnglish (Canada): \n\n- Microsoft: Liam, Clara (neutral voices)\n\nEnglish (Hongkong): \n\n- Microsoft: Yan, Sam (neutral voices)\n\nEnglish (Ireland): \n\n- Microsoft: Emily, Connor (neutral voices)\n\nEnglish (Kenya): \n\n- Microsoft: Asilia, Chilemba (neutral voices)\n\nEnglish (New Zeland): \n\n- Microsoft: Molly, Mitchell (neutral voices)\n\nEnglish (Nigeria): \n\n- Microsoft: Ezinne, Abeo (neutral voices)\n\nEnglish (Philippines): \n\n- Microsoft: Rosa, James (neutral voices)\n\nEnglish (South Africa): \n\n- Microsoft: Leah, Luke (neutral voices)\n\nEnglish (Tanzania): \n\n- Microsoft: Imani, Elimu (neutral voices)\n\nFrench (Belgium): \n\n- Microsoft: Charlie, Gerard (neutral voices)\n\nFrench (Switzerland): \n\n- Microsoft: Ariane, Fabrice (neutral voices)\n\nGalician (Spain): \n\n- Microsoft: Sabela, Roi (neutral voices)\n\nGerman (Austria): \n\n- Microsoft: Ingrid, Jonas (neutral voices)\n\nGerman (Switzerland): \n\n- Microsoft: Jan (neutral voice)\n\nGujarati (India): \n\n- Microsoft: Dhwani, Niranjan (neutral voices)\n\nIrish (Ireland): \n\n- Microsoft: Orla, Colm (neutral voices)\n\nJavanese (Indonesia): \n\n- Microsoft: Siti, Dimas (neutral voices)\n\nKannada (India): \n\n- Microsoft: Sapna, Gagan (neutral voices)\n\nKazakh (Kazakhstan): \n\n- Microsoft: Aigul, Daulet (neutral voices)\n\nKhmer (Cambodia): \n\n- Microsoft: Sreymom, Piseth (neutral voices)\n\nLao (Laos):\n\n- Microsoft: Keomany, Chanthavong (neutral voices)\n\nLithuanian (Lithuania): \n\n- Microsoft: Ona, Leonas (neutral voices)\n\nMacedonian (North Macedonia): \n\n- Microsoft: Marija, Aleksandr (neutral voices)\n\nMalay: \n\n- Microsoft: Yasmin, Osman (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nMalayalam (India): \n\n- Microsoft: Sobhana, Midhun (neutral voices)\n\nMaltese (Malta): \n\n- Microsoft: Grace, Joseph (neutral voices)\n\nMarathi (India): \n\n- Microsoft: Aarohi, Manohar (neutral voices)\n\nPashto (Afghanistan): \n\n- Microsoft: Latifa, GulNawaz (neutral voices)\n\nPersian (Iran): \n\n- Microsoft: Dilara, Farid (neutral voices)\n\nSerbian (Serbia, Cyrillic): \n\n- Microsoft: Sophie, Nicholas (neutral voices)\n\nSinhala (Sri Lanka): \n\n- Microsoft: Thilini, Sameera (neutral voices)\n\nSlovenian: \n\n- Microsoft: Petra, Rok (neutral voices)\n\nSomali (Somalia): \n\n- Microsoft: Ubax, Muuse (neutral voices)\n\nSpanish (Bolivia): \n\n- Microsoft: Sofia, Marcelo (neutral voices)\n\nSpanish (Chile): \n\n- Microsoft: Catalina, Lorenzo (neutral voices)\n\nSpanish (Costa Rica): \n\n- Microsoft: Maria, Juan (neutral voices)\n\nSpanish (Cuba): \n\n- Microsoft: Belkys, Manuel (neutral voices)\n\nSpanish (Dominican Republic): \n\n- Microsoft: Ramona, Emilio (neutral voices)\n\nSpanish (Ecuador):\n\n- Microsoft: Andrea, Luis (neutral voices)\n\nSpanish (El Salvador): \n\n- Microsoft: Lorena, Rodrigo (neutral voices)\n\nSpanish (Equatorial Guinea): \n\n- Microsoft: Teresa, Javier (neutral voices)\n\nSpanish (Guatemala): \n\n- Microsoft: Marta, Andres (neutral voices)\n\nSpanish (Honduras): \n\n- Microsoft: Karla, Carlos (neutral voices)\n\nSpanish (Nicaragua): \n\n- Microsoft: Yolanda, Federico (neutral voices)\n\nSpanish (Panama): \n\n- Microsoft: Margarita, Roberto (neutral voices)\n\nSpanish (Paraguay): \n\n- Microsoft: Tania, Mario (neutral voices)\n\nSpanish (Peru): \n\n- Microsoft: Camila, Alex (neutral voices)\n\nSpanish (Puerto Rico): \n\n- Microsoft: Karina, Victor (neutral voices)\n\nSpanish (Uruguay): \n\n- Microsoft: Valentina, Mateo (neutral voices)\n\nSpanish (Venezuela): \n\n- Microsoft: Paola, Sebastian (neutral voices)\n\nSundanese (Indonesia):\n\n- Microsoft: Tuti, Jajang (neutral voices)\n\nSwahili (Tanzania): \n\n- Microsoft: Rehema, Daudi (neutral voices)\n\nTamil (India):\n\n- Microsoft: Pavalli, Valluvar (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nTamil (Singapore): \n\n- Microsoft: Venba, Anbu (neutral voices)\n\nTamil (Sri Lanka):\n\n- Microsoft: Saranya, Kumar (neutral voices)\n\nTelugu (India): \n\n- Microsoft: Shruti, Mohan (neutral voices)\n\nThai: \n\n- Microsoft: Premwadee, Niwat, Achara (neutral voices)\n\nUrdu (India): \n\n- Microsoft: Gul, Salman (neutral voices)\n\n- Google: Wavenet_A, Wavenet_B, Standard_A, Standard_B\n\nUrdu (Pakistan): \n\n- Microsoft: Uzma, Asad (neutral voices)\n\nZulu (South Africa): \n\n- Microsoft: Thando, Themba (neutral voices)\n\nUzbek: \n\n- Microsoft: Madina, Sardor (neutral voices)\n\nHebrew: (Israel): \n\n- Microsoft: Avri, Hila (neutral voices)\n\nSpanish (Colombia): \n\n- Microsoft: Gonzalo, Salome (neutral voices)\n\nEstonian (Estonia): \n\n- Microsoft: Anu, Kert (neutral voices)\n\nLatvian (Latvia): \n\n- Microsoft: Everita, Nils (neutral voices)"},{"key":"region","value":"europe","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is tts.\n\nThe synthesized speech text for outbound call recording notifications. "},{"key":"client_waiting_media_id","value":"","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the after service time limit is enabled for the campaign. When enabled, the campaign agents have limited time to spend on post-call activities, like making call records, adding contacts, or assigning wrap-up codes. The default setting is false."},{"key":"voicemail_detection_timeout_continue_call","value":"true","type":"text","description":"Integer. Required if afterservice_time_limit_enabled is true.\n\nThe maximum time the campaign agents can spend on post-call activities (1-600). The default value is 60.\n"},{"key":"phone_numbers","value":"{\"phone_number_ids\":[1080]}","type":"text","description":"Boolean. Optional.\n\nSpecifies whether campaign agents can use tags to classy dialogues.\n\nDefault is false."},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.\n\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.\n\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted. \n\nIf you do not pass this parameter, the repeated_attempts value is set.","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/createAgent"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 8917,\n \"title\": \"My agent campaign\",\n \"status\": \"draft\",\n \"mode\": \"predictive\",\n \"folder_id\": null,\n \"date_start\": null,\n \"date_end\": null,\n \"working_time\": [\n \"\",\n \"\"\n ],\n \"max_attempts\": 1,\n \"interval\": 0,\n \"phone_number_id\": null,\n \"caller_id\": null,\n \"settings\": {\n \"voicemail_detection_enabled\": false,\n \"voicemail_detection_model\": null,\n \"voicemail_detection_timeout_sec\": null,\n \"dial_up_time_sec\": 40,\n \"outbound_call_recording\": {\n \"enabled\": false,\n \"mode\": null,\n \"notification\": {\n \"type\": \"none\",\n \"tts_text\": null,\n \"tts_voice\": null,\n \"tts_language\": null,\n \"media_id\": null\n },\n \"storage_period\": \"DEFAULT\"\n },\n \"client_waiting_media_id\": null,\n \"voicemail_detection_timeout_continue_call\": true\n },\n \"create_date\": \"2025-09-22 08:57:56\",\n \"created_by\": 4651,\n \"edit_date\": null,\n \"edited_by\": null,\n \"queue\": {\n \"id\": 14257,\n \"title\": \"Test PDS\",\n \"operator_priority_strategy\": \"MAX_WAITING_TIME\",\n \"request_priority_strategy\": \"MAX_PRIORITY\",\n \"afterservice_time_limit_enabled\": false,\n \"afterservice_time_limit\": 5,\n \"agents_can_end_calls\": false,\n \"agents_can_decline_calls\": false\n },\n \"timezone\": \"Europe/Lisbon\",\n \"sip_number_id\": null,\n \"use_tags\": true,\n \"use_topics\": false,\n \"topic_set_id\": null,\n \"task_multiplier\": 1,\n \"abandonment_rate\": 3,\n \"reference_ip\": null,\n \"region\": null,\n \"region_enabled\": false,\n \"wrap_up_codes_set_id\": null,\n \"dnc_lists\": [],\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"id\": 1080,\n \"phone_number_active\": true,\n \"phone_number\": \"47420001100\"\n }\n ]\n }\n }\n}"}],"_postman_id":"b9adca9b-84d9-4335-adb7-33e90df0fac5"},{"name":"updateAgent","event":[{"listen":"prerequest","script":{"id":"b7fcfc8d-37cf-4fe3-b9da-395221ab1032","exec":["var moment = require('moment');","afterTenDays = moment().add(10, 'days');","","pm.environment.set('currentDate', moment().format((\"YYYY-MM-DD hh:mm:ss\")));","pm.environment.set('afterTenDays', afterTenDays.format((\"YYYY-MM-DD hh:mm:ss\")));"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0cfad26e-b7c4-4dce-921c-bc67630ef0ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1579","type":"text","description":"Integer. Required.
\nThe identifier of the automated campaign you want to update. Use the search method to retrieve the list of available campaign IDs.
\n"},{"key":"title","value":"Campaign","type":"text","description":"String. Optional.
\nThe name of the agent campaign you want to update (1-40 symbols).
\n"},{"key":"planned_date_start","value":"2025-01-10 13:27:18","type":"text","description":"String. Optional.
\nThe campaign scheduled end date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"planned_date_end","value":"2025-02-10 10:50:00","type":"text","description":"String. Optional.
\nThe campaign scheduled end date and time.
\nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null.
\n","disabled":true},{"key":"max_lines","value":"5","type":"text","description":"Integer. Optional.
\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account.
\n","disabled":true},{"key":"region","value":"europe","type":"text","description":"String. Optional.
\nThe region to launch the campaign.
\nThe options are: usa|europe|south_america|singapore|russia|kazakhstan.
\n","disabled":true},{"key":"max_attempts","value":"140","type":"text","description":"Integer. Optional.
\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10).
\n","disabled":true},{"key":"dialing_strategy","value":"[{\"key\": \"phone1\", \"name\": \"Phone 1\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}]","type":"text","description":"JSON array. Optional.
\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.
\nExample: [{\"key\": \"phone1\", \"name\": \"Phone 1\", \"interval_min\": [], \"max_attempts\": 1, \"dial_up_time_sec\": 15}].
\nFor campaigns in the Ongoing, Scheduled, and Paused statuses you CAN edit max_attempts, dial_up_time_sec, and interval_min, but CANNOT add or delete phone numbers or edit their names. This only applies to newly added contacts.
\n","disabled":true},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"JSON array. Optional. Nullable.
\nThe time during which the campaign makes calls.
\n","disabled":true},{"key":"supervisors","value":"[{\"supervisor_id\": 181, \"permission\": \"viewer\"}, {\"supervisor_id\": 182, \"permission\": \"viewer\"}]","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.
\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs.
\n","disabled":true},{"key":"dnc_list_ids","value":"[1]","type":"text","description":"Integer array. Optional. Nullable.
\nThe DNC list ID(s) to bind to the campaign. \nUse the searchDncList method to retrieve the list of DNC list IDs.
\n","disabled":true},{"key":"phone_numbers","value":"{\"caller_id_ids\": [1]}","type":"text","description":"JSON array. Optional.
\nIdentifiers of campaign Caller IDs (own, rented, or sip).
\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.
\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}
\n","disabled":true},{"key":"mode","value":"predictive","type":"text","description":"String. Optional.
\nThe campaign dialing mode. The optiona are: predictive|progressive.
\nPredictive - The mode is based on statistical analysis of the results of recent dialing attempts. The essence of this mode is that the system knows the average duration of a dialogue between an employee and a customer, the number of agents, dialing time, etc., and makes a call without waiting for an agent to become available.
\nProgressive - The mode is based on analyzing the number of available agents. Dialing starts automatically and, in case of a successful connection, the call is directed to an available agent.
\nString. Required if \"mode\" is set to predictive.
\nSelect how the system should determine the pace of placing calls to agents in predictive campaigns: by Abandon rate or by Busy factor. The options are abandon_rate|agent_busy_factor.
\nAbandon rate - a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100.
\nBusy factor - a parameter that defines the target level of agent occupancy (min. - 1, max. - 100
\n","disabled":true},{"key":"abandonment_rate","value":"10","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is abandon_rate.
\nAbandon rate is a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls in predictive campaigns. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100.
\n","disabled":true},{"key":"agent_busy_factor","value":"10","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is agent_busy_factor.
\nBusy factor is a parameter that defines the target level of agent occupancy in predictive campaigns (min. - 1, max. - 100).
\n","disabled":true},{"key":"task_multiplier","value":"","type":"text","description":"Float. Required if \"mode\" is set to progressive.
\nThe workload distribution factor that determines the pace of placing calls to each idle agent in progressive campaigns. The minimum value is 1, the maximum is 25. For campaigns with more than 20 agents, the limit is 100.
\n","disabled":true},{"key":"agents_can_end_calls","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the campaign agents can dend external calls. The default setting is false.
\n","disabled":true},{"key":"agents_can_decline_calls","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the campaign agents can decline external calls. The default setting is false.
\n","disabled":true},{"key":"call_auto_answer","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the auto-answer calls feature is enabled for the campaign. When an inbound call comes in, the system automatically connects a customer to an agent. The default setting is false.
\n","disabled":true},{"key":"voicemail_detection_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the voicemail detection feature is enabled for the campaign. The default setting is false.
\n","disabled":true},{"key":"voicemail_detection_model","value":"ru","type":"text","description":"String. Required if voicemail_detection_enabled is true.
\nThe voicemail detection model to use in the campaign.
\nThe options are 'ru' | 'kz' | 'colombia' | 'br' | 'mx' | 'ph' | 'pe' | 'us' | 'cl' | 'ru_experimental_vm' | 'ru_experimental_human'.
\n","disabled":true},{"key":"voicemail_detection_timeout_sec","value":"9.5","type":"text","description":"Float. Required if voicemail_detection_enabled is true.
\nThe maximum detection time. Minimum = 1.0, max = 10.0. Can be fractional.
\n","disabled":true},{"key":"voicemail_detection_timeout_continue_call","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies how the system should behave if it fails to detect whether it reached a live person or voicemail.
\nIf set to \"true\", the call is routed to a campaign agent.
\nIf set to \"false\", the call is terminated.
\nDefault is false.
\n","disabled":true},{"key":"client_waiting_media_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the system should play an audio recording to a customer while waiting for an agent. When set to false, a customer waits for an agent in silence.
\nDefault is false.
\n","disabled":true},{"key":"client_waiting_media_id","value":"1","type":"text","description":"Integer. Required if client_waiting_media_enabled is true.
\nThe ID of the media file that will be played to a customer while waiting for an agent. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"can_outbound_record","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether outbound call recording is enabled for the campaign. When enabled, the system records all outbound calls and stores the recordings in the Call history section, so that you could listen and download them. The default setting is false.
\nIMPORTANT! In some countries, you are compelled by law to inform the other party that you are recording the call.
\n","disabled":true},{"key":"outbound_record_notification_type","value":"media","type":"text","description":"String. Required if can_outbound_record is true.
\nThe notification type used to inform a customer that the call is being recorded. The options are none|media|tts. The default value is none.
\n","disabled":true},{"key":"outbound_record_notification_duration","value":"SIXMONTHS","type":"text","description":"String. Required if can_outbound_record is true.
\nThe time during which outbound call recordings are available for listening and downloading in the Call history sections. \nThe options are DEFAULT|SIXMONTHS|ONEYEAR|TWOYEARS|THREEYEARS.
\n","disabled":true},{"key":"notification_media_id","value":"1","type":"text","description":"Integer. Required if can_outbound_record is selected and outbound_record_notification_type is media.
\nThe ID of the media file uploaded for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"tts_language","value":"","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech language for outbound call recording notifications.
\nThe following languages are available:
\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft.
\n","disabled":true},{"key":"tts_voice","value":"","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech voice for outbound call recording notifications.
\nThe following options are available:
\nBengali (India):
\nEnglish (US):
\nEnglish (GB):
\nEnglish (AU):
\nEnglish (IN):
\nRussian:
\nGerman:
\nFrench:
\nFrench (CA):
\nItalian:
\nJapanese:
\nDutch:
\nTurkish:
\nKorean:
\nSwedish:
\nDanish:
\nSlovak:
\nPortuguese (BR):
\nPortuguese (PT):
\nPolish:
\nUkrainian:
\nVietnamese:
\nFilipino:
\nArabic:
\nChinese (Mandarin):
\nCzech:
\nGreek:
\nFinnish:
\nHindi:
\nHungarian:
\nIndonesian:
\nNorwegian:
\nSpanish (Castilian):
\nSpanish (US):
\nKazakh (Kazakhstan):
\nSpanish (MX):
\nArabic (SA):
\nWelsh (UK):
\nIcelandic:
\nRomanian:
\nArabic:
\nChinese (Mandarin):
\nSpanish (LA):
\nAfrikaans (South Africa):
\nAmharic (Ethiopia):
\nArabic (Algeria):
\nArabic (Bahrein):
\nArabic (Egypt):
\nArabic (Iraq):
\nArabic (Jordan):
\nArabic (Kuwait):
\nArabic (Libya):
\nArabic (Morocco):
\nArabic (Qatar):
\nArabic (Syria):
\nArabic (Tunisia):
\nArabic (UAE):
\nArabic (Yemen):
\nAzerbaijani (Azerbaijan):
\nBangla (Bangladesh):
\nBulgarian:
\nBurmese (Myanmar):
\nCatalan (Spain):
\nChinese (Cantonese, Traditional):
\nChinese (Taiwanese Mandarin):
\nCroatian:
\nDutch (BE):
\nSpanish (Argentina):
\nNepali (Nepal):
\nEnglish (Canada):
\nEnglish (Hongkong):
\nEnglish (Ireland):
\nEnglish (Kenya):
\nEnglish (New Zeland):
\nEnglish (Nigeria):
\nEnglish (Philippines):
\nEnglish (South Africa):
\nEnglish (Tanzania):
\nFrench (Belgium):
\nFrench (Switzerland):
\nGalician (Spain):
\nGerman (Austria):
\nGerman (Switzerland):
\nGujarati (India):
\nIrish (Ireland):
\nJavanese (Indonesia):
\nKannada (India):
\nKazakh (Kazakhstan):
\nKhmer (Cambodia):
\nLao (Laos):
\nLithuanian (Lithuania):
\nMacedonian (North Macedonia):
\nMalay:
\nMalayalam (India):
\nMaltese (Malta):
\nMarathi (India):
\nPashto (Afghanistan):
\nPersian (Iran):
\nSerbian (Serbia, Cyrillic):
\nSinhala (Sri Lanka):
\nSlovenian:
\nSomali (Somalia):
\nSpanish (Bolivia):
\nSpanish (Chile):
\nSpanish (Costa Rica):
\nSpanish (Cuba):
\nSpanish (Dominican Republic):
\nSpanish (Ecuador):
\nSpanish (El Salvador):
\nSpanish (Equatorial Guinea):
\nSpanish (Guatemala):
\nSpanish (Honduras):
\nSpanish (Nicaragua):
\nSpanish (Panama):
\nSpanish (Paraguay):
\nSpanish (Peru):
\nSpanish (Puerto Rico):
\nSpanish (Uruguay):
\nSpanish (Venezuela):
\nSundanese (Indonesia):
\nSwahili (Tanzania):
\nTamil (India):
\nTamil (Singapore):
\nTamil (Sri Lanka):
\nTelugu (India):
\nThai:
\nUrdu (India):
\nUrdu (Pakistan):
\nZulu (South Africa):
\nUzbek:
\nHebrew: (Israel):
\nSpanish (Colombia):
\nEstonian (Estonia):
\nLatvian (Latvia):
\nString. Required if can_outbound_record is selected and outbound_record_notification_type is tts.
\nThe synthesized speech text for outbound call recording notifications.
\n","disabled":true},{"key":"afterservice_time_limit_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the after service time limit is enabled for the campaign. When enabled, the campaign agents have limited time to spend on post-call activities, like making call records, adding contacts, or assigning wrap-up codes. The default setting is false.
\n","disabled":true},{"key":"afterservice_time_limit_sec","value":"10","type":"text","description":"Integer. Required if afterservice_time_limit_enabled is true.
\nThe maximum time the campaign agents can spend on post-call activities (1-600). The default value is 60.
\n","disabled":true},{"key":"use_tags","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether campaign agents can use tags to classy dialogues.
\nDefault is false.
\n","disabled":true},{"key":"use_topics","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether campaign agents can use topics to classy dialogues.
\nDefault is false.
\n","disabled":true},{"key":"topics_set_id","value":"1","type":"text","description":"Integer. Required if use_topics is true.
\nThe topic set assigned to the campaign for dialogue classification. Use the searchTopicSets method to retrieve the list of available topic sets.
\n","disabled":true},{"key":"user_ids","value":"[4673, 4651]","type":"text","description":"Integer array. Optional.
\nThe campaign agents' IDs. Use the searchUsers method to retrieve the list of user IDs.
\n"},{"key":"use_wrap_up_codes","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether campaign agents can assign wrap-up codes. You assign a wrap-up codes set to your campaign if you want the campaign agents to label the outcome of their calls after interaction with a customer.
\n"},{"key":"wrap_up_codes_set_id","value":"","type":"text","description":"Integer. Required if use_wrap_up_codes is true.
\nThe wrap-up codes set ID.
\n"},{"key":"wrap_up_dnc_list_id","value":"","type":"text","description":"Integer. Optional.
\nThe DNC list ID to assign to the campaign.
\nIf the wrap-up codes set you attached to the campaign contains the Add to DNC list code, the system prompts you to bind a DNC list.
\nUse the searchDncList method to retrieve available DNC lists.
\n"},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional.
\nThe campaign folder ID.
\n","disabled":true},{"key":"priority","value":"1","description":"Integer. Optional.
\nThe campaign priority against inbound queues. Available values are from 1 (highest priority) to 10 (lowest priority).
\n","type":"text","uuid":"f1d65f10-47c2-4492-b92f-5f3adaac69a6","disabled":true},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.
\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.
\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted.
\nIf you do not pass this parameter, the repeated_attempts value is set.
\n","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/updateAgent?domain={{domain}}","description":"Updates an agent campaign.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","updateAgent"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"a69b9a85-2777-4212-a064-d89818ae1355","name":"updateAgent","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"domain","value":"{{domain}}","type":"text","description":"Integer. Required.\n\nThe identifier of the automated campaign you want to update. Use the search method to retrieve the list of available campaign IDs."},{"key":"id","value":"1","type":"text","description":"String. Optional.\n\nThe name of the agent campaign you want to update (1-40 symbols)."},{"key":"title","value":"Test PDS Update","type":"text","description":"String. Optional.\n\nThe campaign scheduled end date and time.\n \nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null."},{"key":"max_attempts","value":"1","type":"text","description":"String. Optional.\n\nThe campaign scheduled end date and time.\n \nThe supported format is YYYY-MM-DD HH:mm:ss. The default value is null."},{"key":"use_tags","value":"true","type":"text","description":"Integer. Optional.\n\nThe maximum number of phone line the campaign can simultaneously use (1-3000). The value cannot exceed the maximum number of lines on the account."},{"key":"use_topics","value":"false","type":"text","description":"String. Optional.\n\nThe region to launch the campaign.\n\nThe options are: usa|europe|south_america|singapore|russia|kazakhstan."},{"key":"interval","value":"60","type":"text","description":"Integer. Optional.\n\nThe maximum number of dialing attempts the system can make on a contact within the campaign (up to 140 attempts, default is 10)."},{"key":"working_time","value":"[\"\",\"\"]","type":"text","description":"JSON array. Optional.\n\nThe campaign dialing strategy. The strategy determines the order of dialing phone number types of a contact, the maximum number of attempts per phone number, dialing time, and interval between attempts.\n\nExample: [{\"name\": \"phone 1\", \"max_attempts\": 3, \"dial_up_time_sec\": 15, \"interval_min\": [3, 4]}]."},{"key":"user_ids","value":"[]","type":"text","description":"JSON array. Optional. Nullable.\n\nThe time during which the campaign makes calls."},{"key":"mode","value":"predictive","type":"text","description":"JSON (object array, permission enum: editor|viewer). Optional. Nullable.\n\nThe campaign supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs."},{"key":"voicemail_detection_enabled","value":"false","type":"text","description":"Integer array. Optional. Nullable.\n\nThe DNC list ID(s) to bind to the campaign. \nUse the searchDncList method to retrieve the list of DNC list IDs."},{"key":"dial_up_time_sec","value":"40","type":"text","description":"JSON array. Optional.\n\nIdentifiers of campaign Caller IDs (own, rented, or sip).\n\nUse the searchNumbers method to retrieve available rented phone numbers. Use the searchCallerIDs method to retrieve available own phone numbers. Use the searchSipNumber method to retrieve the list of available sip numbers.\n\nExample: {\"phone_number_ids\": [1,2,3,4], \"caller_id_ids\": [1]} | {\"sip_number_ids\": [3,4,8]]}"},{"key":"afterservice_time_limit_enabled","value":"false","type":"text","description":"String. Optional.\n\nThe campaign dialing mode. The optiona are: predictive|progressive.\n\n- Predictive - The mode is based on statistical analysis of the results of recent dialing attempts. The essence of this mode is that the system knows the average duration of a dialogue between an employee and a customer, the number of agents, dialing time, etc., and makes a call without waiting for an agent to become available.\n\n- Progressive - The mode is based on analyzing the number of available agents. Dialing starts automatically and, in case of a successful connection, the call is directed to an available agent."},{"key":"afterservice_time_limit","value":"0","type":"text","description":"String. Required if \"mode\" is set to predictive.\n\nSelect how the system should determine the pace of placing calls to agents in predictive campaigns: by Abandon rate or by Busy factor. The options are abandon_rate|agent_busy_factor.\n\nAbandon rate - a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100.\n\nBusy factor - a parameter that defines the target level of agent occupancy (min. - 1, max. - 100"},{"key":"can_outbound_record","value":"false","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is abandon_rate.\n\nAbandon rate is a parameter that determines the speed of initiating calls by adjusting the percentage of abandoned calls in predictive campaigns. This parameter helps regulate how quickly calls should be initiated while not exceeding a specified percentage of abandoned calls. The minimum value is 1, and the maximum is 100."},{"key":"outbound_record_notification_type","value":"none","type":"text","description":"Integer. Required if \"mode\" is set to predictive and \"predictive_mode\" is agent_busy_factor.\n\nBusy factor is a parameter that defines the target level of agent occupancy in predictive campaigns (min. - 1, max. - 100)."},{"key":"outbound_record_notification_duration","value":"DEFAULT","type":"text","description":"Float. Required if \"mode\" is set to progressive.\n\nThe workload distribution factor that determines the pace of placing calls to each idle agent in progressive campaigns. The minimum value is 1, the maximum is 15."},{"key":"tts_language","value":"VoiceList.Yandex","type":"text","description":"Boolean. Optional. \n\nSpecifies whether the campaign agents can dend external calls. The default setting is false."},{"key":"tts_voice","value":"Neural.ru_RU_alena","type":"text","description":"Boolean. Optional. \n\nSpecifies whether the campaign agents can decline external calls. The default setting is false."},{"key":"tts_text","value":"","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the auto-answer calls feature is enabled for the campaign. When an inbound call comes in, the system automatically connects a customer to an agent. The default setting is false."},{"key":"properties","value":"[]","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the voicemail detection feature is enabled for the campaign. The default setting is false."},{"key":"agents_can_decline_calls","value":"false","type":"text","description":"String. Required if voicemail_detection_enabled is true.\n\nThe voicemail detection model to use in the campaign. \n\nThe options are 'ru' | 'kz' | 'colombia' | 'br' | 'mx' | 'ph' | 'pe' | 'us' | 'cl' | 'ru_experimental_vm' | 'ru_experimental_human'."},{"key":"agents_can_end_calls","value":"false","type":"text","description":"Float. Required if voicemail_detection_enabled is true.\n\nThe maximum detection time. Minimum = 1.0, max = 10.0. Can be fractional."},{"key":"call_auto_answer","value":"false","type":"text","description":"Boolean. Optional.\n\nSpecifies how the system should behave if it fails to detect whether it reached a live person or voicemail.\n\nIf set to \"true\", the call is routed to a campaign agent.\n\nIf set to \"false\", the call is terminated.\n\nDefault is false."},{"key":"dnc_lists","value":"[]","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the system should play an audio recording to a customer while waiting for an agent. When set to false, a customer waits for an agent in silence.\n\nDefault is false."},{"key":"wrap_up_codes_set_id","value":"","type":"text","description":"Integer. Required if client_waiting_media_enabled is true.\n\nThe ID of the media file that will be played to a customer while waiting for an agent. Use the searchMedia method to retrieve the list of available media files."},{"key":"abandonment_rate","value":"3","type":"text","description":"Boolean. Optional.\n\nSpecifies whether outbound call recording is enabled for the campaign. When enabled, the system records all outbound calls and stores the recordings in the Call history section, so that you could listen and download them. The default setting is false.\n\nIMPORTANT! In some countries, you are compelled by law to inform the other party that you are recording the call."},{"key":"task_multiplier","value":"1","type":"text","description":"String. Required if can_outbound_record is true.\n\nThe notification type used to inform a customer that the call is being recorded. The options are none|media|tts. The default value is none."},{"key":"voicemail_detection_model","value":"br","type":"text","description":"String. Required if can_outbound_record is true.\n\nThe time during which outbound call recordings are available for listening and downloading in the Call history sections. \nThe options are DEFAULT|SIXMONTHS|ONEYEAR|TWOYEARS|THREEYEARS."},{"key":"voicemail_detection_timeout_sec","value":"6.5","type":"text","description":"Integer. Required if can_outbound_record is selected and outbound_record_notification_type is media.\n\nThe ID of the media file uploaded for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files."},{"key":"supervisors","value":"[{\"permission\":\"viewer\"}]","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.\n\nThe synthesized speech language for outbound call recording notifications.\n\nThe following languages are available:\n\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft."},{"key":"selectedSupervisorsIds","value":"[4673]","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.\n\nThe synthesized speech voice for outbound call recording notifications.\n\nThe following options are available:\n\nBengali (India):\n \n- Google: Wavenet_A, Wavenet_B (neutral voices), Standard_A, Standard_B (common voices)\n- Microsoft: Tanishaa, Bashkar (neutral voices)\n\nEnglish (US): \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E, Standard_B, Standard_C, Standard_D, Standard_E (common voices), Wavenet_F (neutral voices), Neural2_A, Neural2_C, Neural2_D, Neural2_E, Neural2F, Neural2_G, Neural2_H, Neural2_I, Neural2_J, News_K, News_L, News_M, Studio O, Studio Q, News_N, Journey_O \n- Yandex: Alyss, Nick (common voices)\n- Amazon: Ivy, Joanna, Kendra, Kimberly, Salli, Joey,Justin, Matthew (neutral voices), Joanna, Joey (common voices)\n- IBM: Allison, Emily, Henry, Kevin, Lisa, Michael,Olilia (neutral voices), Allison, Lisa, Michael (common voices)\n- Microsoft: Amber, Ashley, Cora, Elizabeth, Michelle, Monica, Sara, Ana, Brandon, Christopher, Eric, Jacob, Aria, Guy (neutral voices), Ava, Andrew, Emma, Brian\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nEnglish (GB):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices) \n- Amazon: Amy, Emma, Brian (neutral voices), Amy, Brian (common voices)\n- IBM: Kate (neutral voice), Kate (common voice)\n- Microsoft: Sonia, Ryan, Libby Mia (neutral voices)\n\nEnglish (AU):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Nicole, Russel (common voices)\n- Microsoft: William, Natasha (neutral voices)\n\nEnglish (IN):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Wavenet_E, Wavenet_F, Standard_B, Standard_C, Standard_A (common voices), Standard_E, Standard_F\n- Amazon: Aditi (common voice)\n- Microsoft: Prabhat, Neerja (neutral voices)\n\nRussian:\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Yandex: Alena, Filipp (neutral voices), Jane, Omazh, Zahar, Ermil (common voices)\n- Amazon: Maxim, Tatyana (common voices)\n- TBank: Anna, Dima\n- Microsoft: Dariya, Svetlana, Dmitry (neutral voices)\n- SaluteSpeech: Natalia, Boris, Marfa, Taras, Alexandra, Sergey (common voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nGerman: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_E (common voices) \n- Amazon: Marlene, Hans (common voices)\n- IBM: Birgit, Dieter, Erika (neutral voices), Birgit, Dieter (common voices)\n- Microsoft: Conrad, Katja (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nFrench: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_E (common voices), Standard_F, Standard_G\n- Amazon: Celine, Mathieu (common voices)\n- IBM: Renee (neutral voice), Renee (common voice)\n- Microsoft: Henri, Denise (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nFrench (CA): \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Chantal (common voice)\n- Microsoft: Antonie, Jean, Sylvie (neutral voices)\n\nItalian: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Carla, Giorgio (common voices)\n- IBM: Francesca (neutral voice), Francesca (common voice)\n- Microsoft: Isabella, Diego, Elsa (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nJapanese: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Mizuki, Takumi (common voices)\n- IBM: Emi (neutral voice), Emi (common voice)\n- Microsoft: Keita, Nanami (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nDutch: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Lotte, Rubin (common voices)\n- IBM: Emi (neutral voice), Emi (common voice)\n- Microsoft: Fenna, Maarten, Colette (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nTurkish: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Lotte, Rubin (common voices)\n- Yandex: Sila Erkan, Erkan Yavas\n- Amazon: Filiz (common voice)\n- Microsoft: Ahmet, Emel (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nKorean: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices) \n- IBM: Youngmi, Yuna (common voices)\n- Microsoft: InJoon, SunHi (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nSwedish: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Amazon: Astrid (common voice)\n- Microsoft: Sopie, Mattias, Hillevi (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nDanish: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Amazon: Naja, mads (common voices)\n- Microsoft: Jeppe, Christel\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nSlovak: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Viktoria, Lukas (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nPortuguese (BR):\n\n- Google: Wavenet_A (neutral voice), Wavenet_D, Wavenet_E, Standard_A (common voice), Standard_D, Standard_E, Standard_B, Standard_C\n- Amazon: Camila (neutral voice), Viktoria, Ricardo (common voices)\n- IBM: Isabela (neutral voice), Isabela (common voice)\n- Microsoft: Antonio, Francisca (neutral voices)\n- ElevenLabs: Conrado Bueno, ScheilaSMTy, Marcio - Bold & Captivating, Rener, Vinicius Bergamo, Brazilian Dudy, Samuel - Jovem Empreendedor, João Pedro\n\nPortuguese (PT):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\n- Amazon: Ines, Cristiano (common voices)\n- Microsoft: Raquel, Duarte, Fernanda (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nPolish: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Maja, Jan (common voices)\n- Microsoft: Agnieszka, Marek, Zofia (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nUkrainian:\n \n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Polina, Ostap (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nVietnamese: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices) \n- Microsoft: HoaiMy, NamMinh (neutral voices)\n\nFilipino:\n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Blessica, Angelo (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nArabic: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices) \n\nChinese (Mandarin):\n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices) \n- Microsoft: Xiaochen, Xiaorou, Xiaorou (dialects), Xiaoxiao (multilingual), Xiaoyu, Yunjie, Yunyi\n\nCzech: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Vlasta, Antonin (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nGreek: \n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Athina, Nestoras (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nFinnish:\n \n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Harri, Noora (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nHindi: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Wavenet_E, Wavenet_F, Standard_B, Standard_C, Standard_A (common voices), Standard_E, Standard_F \n- Amazon: Aditi (common voice)\n- Microsoft: Madhur, Swara (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nHungarian:\n\n- Google: Wavenet_A (neutral voice), Standard_A (common voice)\n- Microsoft: Noemi, Tamas (neutral voices)\n\nIndonesian: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_B, Standard_C, Standard_A (common voices)\n- Microsoft: Gadis, Ardi (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nNorwegian: \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices) \n- Amazon: Liv (common voice)\n- Microsoft: Pernille, Finn, Iselin (neutral voices)\n\nSpanish (Castilian): \n\n- Google: Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A (common voice), Neural2_A, Neural2_B, Neural2_C, Neural2_D, Neural2_E, Neural2_F, Studio_C, Studio_F \n- Amazon: Conchita, Enrique (common voices)\n- IBM: Enrique, Laura (neutral voices), Enrique, Laura (common voices)\n- Microsoft: Elvira (neutral voice)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will, Cristina Campos, Santiago, Gilfoy, Svea - Spanish Customer Care, Alejandra, Miguel, Carolina Ruiz, Sara Martin - 3, Frankie San Juan, Martin Osborne - 6, Alex, Carolina - Spanish woman, Mauricio, Fran - Fresh & Upbeat, EDGARD, Valeria - Friendly Woman, Julius Professional, Dr. Lozano, Alejandro, Julius Master, Pablo (Vambe AI V2), paco, Didak Leñero\n\nSpanish (US): \n\n- Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_A, Standard_B, Standard_C (common voices) \n- Amazon: Lupe (neutral voice), Penelope, Miguel (common voices)\n- IBM: Sofia (neutral voice), Sofia (common voice)\n- Microsoft: Alonso (neutral voice)\n\nKazakh (Kazakhstan): \n\n- YandexV3: Amira (common voice)\n\nSpanish (MX):\n\n- Amazon: Mia (common voice)\n- Microsoft: Jorge, Dalia (neutral voices)\n\nArabic (SA): \n\n- Amazon: Zeina (common voice)\n- Microsoft: Hamed, Zariyah (neutral voices)\n\nWelsh (UK): \n\n- Amazon: Gwyneth, Geraint (common voices)\n- Microsoft: Nia, Aled (neutral voices)\n\nIcelandic: \n\n- Amazon: Dora, Carl (common voices)\n- Microsoft: Gudrun, Gunnar (neutral voices)\n\nRomanian: \n\n- Amazon: Carmen (common voice)\n- Microsoft: Alina, Emil (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nArabic: \n\n- IBM: Omar (common voice)\n\nChinese (Mandarin):\n\n- IBM: LiNa, WangWei, ZhangJing (common voices)\n- Microsoft: Xiaochen, Xiaohan, Xiaomo, Xiaoqiu, Xiaorui, Xiaoshuang, Xiaoxuan, Xiaoyan, Yunxi, Xiaoxiao, Xiaoyou, Yunyang, Yunye (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nSpanish (LA): \n\n- IBM: Sofia (neutral voice), Sofia (common voice)\n\nAfrikaans (South Africa): \n\n- Microsoft: Adri, Willem (neutral voices)\n\nAmharic (Ethiopia):\n\n- Microsoft: Mekdes, Ameha (neutral voices)\n\nArabic (Algeria): \n\n- Microsoft: Amina, Izmael (neutral)\n\nArabic (Bahrein): \n\n- Microsoft: Laila, Ali (neutral)\n\nArabic (Egypt):\n\n- Microsoft: Shakir, Salma (neutral voices)\n\nArabic (Iraq): \n\n- Microsoft: Rana, Bassel (neutral voices)\n\nArabic (Jordan): \n\n- Microsoft: Sana, Taim (neutral voices)\n\nArabic (Kuwait): \n\n- Microsoft: Noura, Fahed (neutral voices)\n\nArabic (Libya): \n\n- Microsoft: Iman, Omar (neutral voices)\n\nArabic (Morocco): \n\n- Microsoft: Mouna, Jamal (neutral voices)\n\nArabic (Qatar): \n\n- Microsoft: Amal, Moaz (neutral voices)\n\nArabic (Syria):\n\n- Microsoft: Amany, Laith (neutral voices)\n\nArabic (Tunisia):\n\n- Microsoft: Reem, Hedi (neutral voices)\n\nArabic (UAE):\n\n- Microsoft: Fatima, Hamdan (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nArabic (Yemen):\n\n- Microsoft: Maryam, Saleh (neutral voices)\n\nAzerbaijani (Azerbaijan): \n\n- Microsoft: Babek, Banu (neutral voices)\n\nBangla (Bangladesh): \n\n- Microsoft: Nabanita, Pradeep (neutral voices)\n\nBulgarian:\n\n- Google: Standard_A\n- Microsoft: Kalina, Borislav\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nBurmese (Myanmar): \n\n- Microsoft: Nilar, Thiha (neutral voices)\n\nCatalan (Spain):\n\n- Microsoft: Joana, Enric, Alba (neutral voices)\n\nChinese (Cantonese, Traditional): \n\n- Microsoft: HiuMaan, WanLung, HiuGaai (neutral voices)\n\nChinese (Taiwanese Mandarin): \n\n- Microsoft: HsiaoChen, YunJhe, HsiaoYu (neutral voices)\n\nCroatian:\n\n- Microsoft: Gabrijela, Srecko (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nDutch (BE): \n\n- Microsoft: Dena, Arnaud (neutral voices)\n\nSpanish (Argentina): \n\n- Microsoft: Elena, Tomas (neutral voices)\n\nNepali (Nepal): \n\n- Microsoft: Sagar, Hemkala (neutral voices)\n\nEnglish (Canada): \n\n- Microsoft: Liam, Clara (neutral voices)\n\nEnglish (Hongkong): \n\n- Microsoft: Yan, Sam (neutral voices)\n\nEnglish (Ireland): \n\n- Microsoft: Emily, Connor (neutral voices)\n\nEnglish (Kenya): \n\n- Microsoft: Asilia, Chilemba (neutral voices)\n\nEnglish (New Zeland): \n\n- Microsoft: Molly, Mitchell (neutral voices)\n\nEnglish (Nigeria): \n\n- Microsoft: Ezinne, Abeo (neutral voices)\n\nEnglish (Philippines): \n\n- Microsoft: Rosa, James (neutral voices)\n\nEnglish (South Africa): \n\n- Microsoft: Leah, Luke (neutral voices)\n\nEnglish (Tanzania): \n\n- Microsoft: Imani, Elimu (neutral voices)\n\nFrench (Belgium): \n\n- Microsoft: Charlie, Gerard (neutral voices)\n\nFrench (Switzerland): \n\n- Microsoft: Ariane, Fabrice (neutral voices)\n\nGalician (Spain): \n\n- Microsoft: Sabela, Roi (neutral voices)\n\nGerman (Austria): \n\n- Microsoft: Ingrid, Jonas (neutral voices)\n\nGerman (Switzerland): \n\n- Microsoft: Jan (neutral voice)\n\nGujarati (India): \n\n- Microsoft: Dhwani, Niranjan (neutral voices)\n\nIrish (Ireland): \n\n- Microsoft: Orla, Colm (neutral voices)\n\nJavanese (Indonesia): \n\n- Microsoft: Siti, Dimas (neutral voices)\n\nKannada (India): \n\n- Microsoft: Sapna, Gagan (neutral voices)\n\nKazakh (Kazakhstan): \n\n- Microsoft: Aigul, Daulet (neutral voices)\n\nKhmer (Cambodia): \n\n- Microsoft: Sreymom, Piseth (neutral voices)\n\nLao (Laos):\n\n- Microsoft: Keomany, Chanthavong (neutral voices)\n\nLithuanian (Lithuania): \n\n- Microsoft: Ona, Leonas (neutral voices)\n\nMacedonian (North Macedonia): \n\n- Microsoft: Marija, Aleksandr (neutral voices)\n\nMalay: \n\n- Microsoft: Yasmin, Osman (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nMalayalam (India): \n\n- Microsoft: Sobhana, Midhun (neutral voices)\n\nMaltese (Malta): \n\n- Microsoft: Grace, Joseph (neutral voices)\n\nMarathi (India): \n\n- Microsoft: Aarohi, Manohar (neutral voices)\n\nPashto (Afghanistan): \n\n- Microsoft: Latifa, GulNawaz (neutral voices)\n\nPersian (Iran): \n\n- Microsoft: Dilara, Farid (neutral voices)\n\nSerbian (Serbia, Cyrillic): \n\n- Microsoft: Sophie, Nicholas (neutral voices)\n\nSinhala (Sri Lanka): \n\n- Microsoft: Thilini, Sameera (neutral voices)\n\nSlovenian: \n\n- Microsoft: Petra, Rok (neutral voices)\n\nSomali (Somalia): \n\n- Microsoft: Ubax, Muuse (neutral voices)\n\nSpanish (Bolivia): \n\n- Microsoft: Sofia, Marcelo (neutral voices)\n\nSpanish (Chile):\n \n- Microsoft: Catalina, Lorenzo (neutral voices)\n\nSpanish (Costa Rica): \n\n- Microsoft: Maria, Juan (neutral voices)\n\nSpanish (Cuba): \n\n- Microsoft: Belkys, Manuel (neutral voices)\n\nSpanish (Dominican Republic):\n \n- Microsoft: Ramona, Emilio (neutral voices)\n\nSpanish (Ecuador):\n\n- Microsoft: Andrea, Luis (neutral voices)\n\nSpanish (El Salvador): \n\n- Microsoft: Lorena, Rodrigo (neutral voices)\n\nSpanish (Equatorial Guinea): \n\n- Microsoft: Teresa, Javier (neutral voices)\n\nSpanish (Guatemala): \n\n- Microsoft: Marta, Andres (neutral voices)\n\nSpanish (Honduras): \n\n- Microsoft: Karla, Carlos (neutral voices)\n\nSpanish (Nicaragua): \n\n- Microsoft: Yolanda, Federico (neutral voices)\n\nSpanish (Panama): \n\n- Microsoft: Margarita, Roberto (neutral voices)\n\nSpanish (Paraguay): \n\n- Microsoft: Tania, Mario (neutral voices)\n\nSpanish (Peru): \n\n- Microsoft: Camila, Alex (neutral voices)\n\nSpanish (Puerto Rico): \n\n- Microsoft: Karina, Victor (neutral voices)\n\nSpanish (Uruguay): \n\n- Microsoft: Valentina, Mateo (neutral voices)\n\nSpanish (Venezuela): \n\n- Microsoft: Paola, Sebastian (neutral voices)\n\nSundanese (Indonesia):\n\n- Microsoft: Tuti, Jajang (neutral voices)\n\nSwahili (Tanzania): \n\n- Microsoft: Rehema, Daudi (neutral voices)\n\nTamil (India):\n\n- Microsoft: Pavalli, Valluvar (neutral voices)\n- ElevenLabs: Alice, Aria, Bill, Brian, Callum, Charlie, Charlotte, Chris, Daniel, Eric, George, Jessica, Laura, Liam, Lily, Matilda, River, Roger, Sarah, Will\n\nTamil (Singapore): \n\n- Microsoft: Venba, Anbu (neutral voices)\n\nTamil (Sri Lanka):\n\n- Microsoft: Saranya, Kumar (neutral voices)\n\nTelugu (India): \n\n- Microsoft: Shruti, Mohan (neutral voices)\n\nThai: \n\n- Microsoft: Premwadee, Niwat, Achara (neutral voices)\n\nUrdu (India): \n\n- Microsoft: Gul, Salman (neutral voices)\n- Google: Wavenet_A, Wavenet_B, Standard_A, Standard_B\n\nUrdu (Pakistan): \n\n- Microsoft: Uzma, Asad (neutral voices)\n\nZulu (South Africa): \n\n- Microsoft: Thando, Themba (neutral voices)\n\nUzbek: \n\n- Microsoft: Madina, Sardor (neutral voices)\n\nHebrew: (Israel): \n\n- Microsoft: Avri, Hila (neutral voices)\n\nSpanish (Colombia): \n\n- Microsoft: Gonzalo, Salome (neutral voices)\n\nEstonian (Estonia): \n\n- Microsoft: Anu, Kert (neutral voices)\n\nLatvian (Latvia): \n\n- Microsoft: Everita, Nils (neutral voices)"},{"key":"region_enabled","value":"false","type":"text","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is tts.\n\nThe synthesized speech text for outbound call recording notifications."},{"key":"region","value":"europe","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the after service time limit is enabled for the campaign. When enabled, the campaign agents have limited time to spend on post-call activities, like making call records, adding contacts, or assigning wrap-up codes. The default setting is false."},{"key":"client_waiting_media_id","value":"","type":"text","description":"Integer. Required if afterservice_time_limit_enabled is true.\n\nThe maximum time the campaign agents can spend on post-call activities (1-600). The default value is 60."},{"key":"voicemail_detection_timeout_continue_call","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether campaign agents can use tags to classy dialogues.\n\nDefault is false."},{"key":"phone_numbers","value":"{\"phone_number_ids\":[1080]}","type":"text","description":"Boolean. Optional.\n\nSpecifies whether campaign agents can use topics to classy dialogues.\n\nDefault is false."},{"key":"task_priority_strategy","value":"repeated_attempts","description":"String. Optional.\n\nSpecifies which contacts the campaign should call first according to the strategy. The options are: first_attempts, repeated_attempts.\n\nWhen set to repeated_attempts, the campaign first calls contacts that have already been attempted. When set to first_attempts, the system prioritizes contacts that have not yet been attempted. \n\nIf you do not pass this parameter, the repeated_attempts value is set.","type":"text","uuid":"a6727650-d217-45d1-b211-e0907a421c12","disabled":true}]},"url":"https://{{host}}/api/v3/campaigns/updateAgent"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 8917,\n \"title\": \"My agent campaign\",\n \"status\": \"draft\",\n \"mode\": \"predictive\",\n \"folder_id\": null,\n \"date_start\": null,\n \"date_end\": null,\n \"working_time\": [\n \"\",\n \"\"\n ],\n \"max_attempts\": 1,\n \"interval\": 0,\n \"phone_number_id\": null,\n \"caller_id\": null,\n \"settings\": {\n \"voicemail_detection_enabled\": false,\n \"voicemail_detection_model\": null,\n \"voicemail_detection_timeout_sec\": null,\n \"dial_up_time_sec\": 40,\n \"outbound_call_recording\": {\n \"enabled\": false,\n \"mode\": null,\n \"notification\": {\n \"type\": \"none\",\n \"tts_text\": null,\n \"tts_voice\": null,\n \"tts_language\": null,\n \"media_id\": null\n },\n \"storage_period\": \"DEFAULT\"\n },\n \"client_waiting_media_id\": null,\n \"voicemail_detection_timeout_continue_call\": true\n },\n \"create_date\": \"2025-09-22 08:57:56\",\n \"created_by\": 4651,\n \"edit_date\": \"2025-09-22 08:59:47\",\n \"edited_by\": 4651,\n \"queue\": {\n \"id\": 14257,\n \"title\": \"My queue\",\n \"operator_priority_strategy\": \"MAX_WAITING_TIME\",\n \"request_priority_strategy\": \"MAX_PRIORITY\",\n \"afterservice_time_limit_enabled\": false,\n \"afterservice_time_limit\": 0,\n \"agents_can_end_calls\": false,\n \"agents_can_decline_calls\": false\n },\n \"timezone\": \"Europe/Lisbon\",\n \"sip_number_id\": null,\n \"use_tags\": true,\n \"use_topics\": false,\n \"topic_set_id\": null,\n \"task_multiplier\": 1,\n \"abandonment_rate\": 3,\n \"reference_ip\": \"\",\n \"region\": null,\n \"region_enabled\": false,\n \"wrap_up_codes_set_id\": null,\n \"dnc_lists\": [],\n \"supervisors\": [],\n \"phone_numbers\": {\n \"phone_numbers\": [\n {\n \"id\": 1080,\n \"phone_number_active\": true,\n \"phone_number\": \"47420001101\"\n }\n ]\n }\n }\n}"}],"_postman_id":"0cfad26e-b7c4-4dce-921c-bc67630ef0ae"},{"name":"cancelContact","id":"0be68e1e-659f-45da-b4d2-7c58e5de6f52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"contact_ids","value":"[419,420,421,434,443,448,450,463,479,498]","description":"Integer array. Required.
\nThe IDs of the contacts you want to cancel. Use the searchContacts method to retrieve the list of contact IDs.
\nThe maximum number of contact IDs to cancel at once is 100.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/cancelContact?domain={{domain}}","description":"Cancels single campaign contacts by their id.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","cancelContact"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"7eb9a88a-2f66-454f-863a-4dd3d207bd11","name":"cancelContact","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"type":"text","key":"contact_id","value":"1","description":"Integer. Required.\n\nThe ID of the contact you want to cancel. Use the searchContacts method to retrieve the list of contact IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/cancelContact?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","cancelContact"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"0be68e1e-659f-45da-b4d2-7c58e5de6f52"},{"name":"cancelLists","id":"5f66857a-ff75-42d2-a33a-232e4c15ed94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"campaign_id","value":"2987","type":"text","description":"Integer. Required.
\nThe ID of the campaign you want to cancel the contact list for. Use the search method to retrieve the list of available campaign IDs.
\n"},{"key":"list_ids","value":"[4074]","type":"text","description":"JSON array. Required.
\nThe contact list IDs you want to cancel. Cancelling a contact list cancels all its contacts.
\nUse the searchLists method to retreive available contact list IDs.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/cancelLists?domain={{domain}}","description":"Cancels campaign contact lists by their id.
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","cancelLists"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"bb80e43c-6aef-474b-9864-4b785d943395","name":"cancelLists","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"campaign_id","value":"2987","type":"text","description":"Integer. Required.\n\nThe ID of the campaign you want to cancel the contact list for. Use the search method to retrieve the list of available campaign IDs."},{"key":"list_ids","value":"[4074]","type":"text","description":"JSON array. Required.\n\nThe contact list IDs you want to cancel. Cancelling a contact list cancels all its contacts.\n\nUse the searchLists method to retreive available contact list IDs."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/cancelLists?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","cancelLists"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"5f66857a-ff75-42d2-a33a-232e4c15ed94"},{"name":"editCallListTasksPriority","id":"276fa576-f0dd-4fe0-ac27-c2f07ef32585","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"list_id","value":"1","type":"text","description":"Integer. Required.\nCampaign call list ID.
\n"},{"key":"tasks","value":"[{\"task_uuid\":\"4eb066e0-a1fc-43d4-8563-48bc5e158b19\",\"task_priority\":4},{\"task_uuid\":\"851fe6ad-961e-436d-b780-718629eb0f78\",\"task_priority\":2}]","type":"text","description":"JSON string. Required.\nList of contacts and their new priorities.
\n"}]},"url":"https://{{host}}/api/v3/campaigns/editCallListTasksPriority?domain={{domain}}&access_token={{access_token}}","description":"Edits contact priorities in a campaign call list by task_uuid****.
The tasks field must contain a JSON array of objects. Each object must include:
task_uuid — contact task UUID
task_priority — new contact priority from 1 to 250000
This method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","campaigns","editCallListTasksPriority"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.\nYour API access token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"c90e674b-a62a-43ef-84df-2dbe21edb02f","name":"Priorities are successfully updated","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"list_id","value":"1","type":"text","description":"Integer. Required.\nCampaign call list ID."},{"key":"tasks","value":"[{\"task_uuid\":\"4eb066e0-a1fc-43d4-8563-48bc5e158b19\",\"task_priority\": 4},{\"task_uuid\": \"851fe6ad-961e-436d-b780-718629eb0f78\",\"task_priority\": 2}]","type":"text","description":"JSON string. Required.\nList of contacts and their new priorities."}]},"url":{"raw":"https://{{host}}/api/v3/campaigns/editCallListTasksPriority?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","campaigns","editCallListTasksPriority"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\nYour API access token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": {\r\n \"changed_priority\": 3,\r\n \"already_succeed_tasks\": 0,\r\n \"already_failed_tasks\": 0,\r\n \"invalid_tasks\": {}\r\n }\r\n}"}],"_postman_id":"276fa576-f0dd-4fe0-ac27-c2f07ef32585"}],"id":"5f0d8375-d3f9-4520-96d1-e7e1d07df16a","description":"This folder contains actions you may need to create an automated or agent campaign, add contacts to a campaign, cancel contacts, and search for campaigns/contacts.
\n","_postman_id":"5f0d8375-d3f9-4520-96d1-e7e1d07df16a"},{"name":"cc","item":[{"name":"agentStatHistory","id":"3e57632d-885b-40a6-8eb2-39abfc38f05b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"user_ids","value":"[1,2,3]","type":"text","description":"JSON array. Optional.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs.
\nBy default, the report includes data for all users.
\n"},{"key":"date_from","value":"2022-11-01 00:00:00","type":"text","description":"String. Optional.
\nThe report start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\nBy default, the report is generated for the last hour from date_to.
\n"},{"key":"date_to","value":"2022-11-02 00:00:00","type":"text","description":"String. Optional.
\nThe report end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\nBy default, the system uses the current date and time.
\n"},{"key":"interval","value":"month","type":"text","description":"String. Required.
\nThe report interval. The system splits the period between the date_from and date_to parameters into intervals and aggregates data accordingly. The options are hour|day|week|month|all.
\nIf the interval is all, the system aggregates data for the whole period between date_from and date_to.
\n"},{"key":"queue_ids","value":"[1,2,3]","type":"text","description":"JSON array. Optional.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues.
\nBy default, the report includes data for all queues.
\n"},{"key":"timezone","value":"Europe/London","description":"String. Optional.
\nThe timezone used in the date_from and date_to parameters. By default, the system uses the timezone specified in the Profile settings.
\n","type":"text"},{"key":"newest_first","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should first display new records. The default setting is false.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/cc/agentStatHistory?domain={{domain}}&sort=-date&page=1&per-page=20","description":"Generates an agent report.
\n","urlObject":{"protocol":"https","path":["api","v3","cc","agentStatHistory"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-date"},{"description":{"content":"Integer. Optional.
\nThe report page number. The default value is 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"20"}],"variable":[]}},"response":[{"id":"f68008d3-bb36-4635-b7b5-9a583aab6f79","name":"agentStatHistory","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"YOUR_ACCESS_TOKEN","type":"text"},{"key":"user_ids","value":"[1,2,3]","type":"text","disabled":true},{"key":"date_from","value":"2022-11-01 00:00:00","type":"text"},{"key":"date_to","value":"2022-11-02 00:00:00","type":"text"},{"key":"interval","value":"month","type":"text"},{"key":"queue_ids","value":"[1,2,3]","type":"text","disabled":true},{"key":"timezone","value":"Europe/London","type":"text","disabled":true},{"key":"newest_first","value":"true","type":"text","disabled":true}]},"url":{"raw":"https://YOUR_ACCOUNT_API_DOMAIN/api/v3/cc/agentStatHistory?domain=YOUR_ACCOUNT_NAME","protocol":"https","host":["YOUR_ACCOUNT_API_DOMAIN"],"path":["api","v3","cc","agentStatHistory"],"query":[{"key":"domain","value":"YOUR_ACCOUNT_NAME"},{"key":"page","value":"1","type":"text","disabled":true},{"key":"per-page","value":"20","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 18 Jul 2022 08:41:09 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kit-Request-Id","value":"75580aee68fc3025882e2262410c5cc9"},{"key":"X-Pagination-Total-Count","value":"7"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"queue_ids","value":"[3428,2580]","type":"text","description":"JSON array. Optional.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues.
\nBy default, the report includes data for all queues.
\n"},{"key":"date_from","value":"","type":"text","description":"String. Optional.
\nThe report start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\nBy default, the report is generated for the last hour from date_to.
\n","disabled":true},{"key":"date_to","value":"","type":"text","description":"String. Optional.
\nThe report end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\nBy default, the system uses the current date and time.
\n","disabled":true},{"key":"interval","value":"day","type":"text","description":"String. Required.
\nThe report interval. The system splits the period between the date_from and date_to parameters into intervals and aggregates data accordingly. The options are hour|day|week|month|all.
\nIf the interval is all, the system aggregates data for the whole period between date_from and date_to.
\n"},{"key":"with_agent_campaign_queues","value":"","description":"Boolean. Optional.
\nSpecifies whether the report should include PDS campaigns. The default setting is false.
\n","type":"text","disabled":true},{"key":"timezone","value":"","description":"String. Optional.
\nThe timezone used in the date_from and date_to parameters. By default, the system uses the timezone specified in the Profile settings.
\n","type":"text","disabled":true},{"key":"newest_first","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should first display new records. The default setting is false.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/cc/queueStatHistory?domain={{domain}}&page=1&per-page=20","description":"Generates a queue report.
\n","urlObject":{"protocol":"https","path":["api","v3","cc","queueStatHistory"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"Integer. Optional.
\nThe report page number. The default value is 1.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"20"}],"variable":[]}},"response":[{"id":"75d9b9da-6840-4eac-9e5e-2a19c404d018","name":"queueStatHistory","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"YOUR_ACCESS_TOKEN","type":"text"},{"key":"queue_ids","value":"[3428,2580]","type":"text"},{"key":"date_from","value":"","type":"text","disabled":true},{"key":"date_to","value":"","type":"text","disabled":true},{"key":"interval","value":"day","type":"text"},{"key":"with_agent_campaign_queues","value":"","type":"text","disabled":true},{"key":"timezone","value":"","type":"text","disabled":true},{"key":"newest_first","value":"false","type":"text"}]},"url":{"raw":"https://YOUR_ACCOUNT_API_DOMAIN/api/v3/cc/queueStatHistory?domain={{domain}}&page=1&per-page=20","protocol":"https","host":["YOUR_ACCOUNT_API_DOMAIN"],"path":["api","v3","cc","queueStatHistory"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."},{"key":"page","value":"1","description":"Optional. Integer. Default=1.\nReport page number."},{"key":"per-page","value":"20","description":"Optional. Integer. Default=20, max=50.\n\nNumber of records per page."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 24 Mar 2023 06:49:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"f6882bd3ace7cbb5928a1f0765991c0d"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"can_inbound_calls","value":"true","type":"text","description":"Boolean. Required.
\nSpecifies whether inbound calls are enabled for the contact center agents. The default setting is false.
\n"},{"key":"can_outbound_calls","value":"true","type":"text","description":"Boolean. Required.
\nSpecifies whether outbound calls are enabled for the contact center agents. The default setting is false.
\nIf can_outbound_calls is true, one of these parameters: outbound_phone_id, outbound_caller_id, or outbound_sip_number_id is required.
\n"},{"key":"outbound_phone_id","value":"1234","type":"text","description":"Integer. Optional.
\nThe ID of the default phone number for outbound calls. This is the ID of the phone number you purchased in Voximplant Kit. Use the searchNumbers method to retrieve available phone numbers.
\n"},{"key":"outbound_sip_number_id","value":"","description":"Integer. Optional.
\nThe ID of the default external phone number for outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.
\n","type":"text","disabled":true},{"key":"outbound_caller_id","value":"","type":"text","description":"Integer. Optional.
\nThe identifier of the Caller ID for outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"can_hold_record","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the system should play an audio recording while a customer is on hold.
\nIf can_hold_record is true, the hold_media_id parameter is required.
\n"},{"key":"hold_media_id","value":"74","type":"text","description":"Integer. Required if can_hold_record is true.
\nThe ID of an audio recording the system plays when a call is on hold. Use the searchMedia method to retrieve the list of available media files.
\n"},{"key":"can_internal_record","value":"true","description":"Boolean. Optional.
\nSpecifies whether internal call recording is enabled for the contact center.
\n","type":"text"},{"key":"can_internal_calls","value":"true","description":"Boolean. Optional.
\nSpecifies whether internal calls are enabled for the contact center agents. The default setting is null.
\n","type":"text"},{"key":"can_change_caller_id","value":"false","description":"Boolean. Optional.
\nSpecifies whether the contact center agents can change the Caller ID for outbound calls via the softphone.
\n","type":"text"},{"key":"hold_notification_enabled","value":"true","description":"Boolean. Optional.
\nSpecifies whether hold notifications are enabled for the contact center.
\n","type":"text"},{"key":"hold_notification_time_sec","value":"30","description":"Integer. Optional.
\nThe threshold time (in sec) when an agent receives a reminder that a customer is on hold. The default value is 30, minimum - 1, maximum - 120.
\n","type":"text"},{"key":"can_outbound_record","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether outbound call recording is enabled for the contact center.
\n"},{"key":"outbound_record_notification_type","value":"media","description":"String. Optional.
\nThe outbound call recording notification type. The options are none|media|tts. The default setting is null.
\n","type":"text"},{"key":"outbound_record_notification_duration","value":"threeyears","type":"text","description":"String. Optional.
\nOutbound call recording storage period. This is the period when outbound call recordings are available for listening and downloading in the Call history section. The options are default|sixmonth|oneyear|twoyears|threeyears.
\n"},{"key":"tts_language","value":"","description":"String. Required if outbound_record_notification_type is tts.
\nThe synthesized speech language for outbound call recording notifications. The maximum length is 255 characters.
\nThe following languages are available:
\nBengali (India): Google, Microsoft;\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft, ElevenLabs;\nEnglish (GB): Google, Amazon, IBM, Microsoft;\nEnglish (AU): Google, Amazon, Microsoft;\nEnglish (IN): Google, Amazon, Microsoft; \nRussian: Google, Yandex, Amazon, TBank, Microsoft, SaluteSpeech, ElevenLabs;\nGerman: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench: Google, Amazon, IBM, Microsoft, ElevenLabs;\nFrench (CA): Google, Amazon, Microsoft;\nItalian: Google, Amazon, IBM, Microsoft, ElevenLabs;\nJapanese: Google, Amazon, IBM, Microsoft, ElevenLabs;\nDutch: Google, Amazon, IBM, Microsoft, ElevenLabs;\nTurkish: Google, Yandex, Amazon, Microsoft, ElevenLabs;\nKorean: Google, IBM, Microsoft, ElevenLabs;\nSwedish: Google, Amazon, Microsoft, ElevenLabs;\nDanish: Google, Amazon, Microsoft, ElevenLabs;\nSlovak: Google, Microsoft, ElevenLabs;\nPortuguese (BR): Google, Amazon, IBM, Microsoft;\nPortuguese (PT): Google, Amazon, Microsoft, ElevenLabs;\nPolish: Google, Amazon, Microsoft, ElevenLabs;\nUkranian: Google, Microsoft, ElevenLabs;\nVietnamese: Google, Microsoft;\nFilipino: Google, Microsoft, ElevenLabs;\nArabic: Google;\nChinese (Mandarin): Google;\nCzech: Google, Microsoft, ElevenLabs;\nGreek: Google, Microsoft, ElevenLabs;\nFinnish: Google, Microsoft2, ElevenLabs;\nHindi: Google, Amazon,Microsoft, ElevenLabs;\nHungarian: Google, Microsoft;\nIndonesian: Google, Microsoft, ElevenLabs;\nNorwegian: Google, Amazon, Microsoft;\nSpanish (Castilian): Google, Amazon, IBM, Microsoft, ElevenLabs;\nBulgarian: Google, Microsoft, ElevenLabs;\nSpanish (US): Google, Amazon, IBM, Microsoft;\nKazakh (Kazakhstan): YandexV3;\nSpanish (MX): Amazon, Microsoft;\nArabic (SA): Amazon, Microsoft;\nWelsh (UK): Amazon, Microsoft;\nIcelandic: Amazon, Microsoft;\nRomanian: Amazon, Microsoft, ElevenLabs;\nArabic: IBM;\nChinese (Mandarin): IBM, Microsoft, ElevenLabs;\nSpanish (LA): IBM;\nAfrikaans (South Africa): Microsoft;\nAmharic (Ethiopia): Microsoft;\nArabic (Algeria): Microsoft;\nArabic (Bahrein): Microsoft;\nArabic (Egypt): Microsoft;\nArabic (Iraq): Microsoft;\nArabic (Jordan): Microsoft;\nArabic (Kuwait): Microsoft;\nArabic (Libya): Microsoft;\nArabic (Morocco): Microsoft;\nArabic (Qatar): Microsoft;\nArabic (Syria): Microsoft;\nArabic (Tunisia): Microsoft;\nArabic (UAE): Microsoft, ElevenLabs;\nArabic (Yemen): Microsoft;\nAzerbaijani (Azerbaijan): Microsoft;\nBangla (Bangladesh): Microsoft;\nBurmese (Myanmar): Microsoft;\nCatalan (Spain): Microsoft;\nChinese (Cantonese, Traditional): Microsoft;\nChinese (Taiwanese Mandarin): Microsoft;\nCroatian: Microsoft, ElevenLabs;\nDutch (BE): Microsoft;\nSpanish (Argentina): Microsoft;\nNepali (Nepal): Microsoft;\nEnglish (Canada): Microsoft;\nEnglish (Hongkong): Microsoft;\nEnglish (Ireland): Microsoft;\nEnglish (Kenya): Microsoft;\nEnglish (New Zeland): Microsoft;\nEnglish (Nigeria): Microsoft;\nEnglish (Philippines): Microsoft;\nEnglish (South Africa): Microsoft;\nEnglish (Tanzania): Microsoft;\nEnglish (Singapore): Google, Microsoft, Deepgram;\nFrench (Belgium): Microsoft;\nFrench (Switzerland): Microsoft;\nGalician (Spain): Microsoft;\nGerman (Austria): Microsoft;\nGerman (Switzerland): Microsoft;\nGujarati (India): Microsoft;\nIrish (Ireland): Microsoft;\nJavanese (Indonesia): Microsoft;\nKannada (India): Microsoft;\nKazakh (Kazakhstan): Microsoft;\nKhmer (Cambodia): Microsoft;\nLao (Laos): Microsoft;\nLithuanian (Lithuania): Microsoft;\nMacedonian (North Macedonia): Microsoft;\nMalay: Microsoft, ElevenLabs;\nMalayalam (India): Microsoft;\nMaltese (Malta): Microsoft;\nMarathi (India): Microsoft;\nMongolian (Mongolia): Google, Microsoft;\nPashto (Afganistan): Microsoft;\nPersian (Iran): Microsoft;\nSerbian (Serbia, Cyrillic): Microsoft;\nSinhala (Sri Lanka): Microsoft;\nSlovenian: Microsoft;\nSomali (Somalia): Microsoft;\nSpanish (Bolivia): Microsoft;\nSpanish (Chile): Microsoft;\nSpanish (Costa Rica): Microsoft;\nSpanish (Cuba): Microsoft;\nSpanish (Dominican Republic): Microsoft;\nSpanish (Ecuador): Microsoft;\nSpanish (El Salvador): Microsoft;\nSpanish (Equatorial Guinea): Microsoft;\nSpanish (Guatemala): Microsoft;\nSpanish (Honduras): Microsoft;\nSpanish (Nicaragua): Microsoft;\nSpanish (Panama): Microsoft;\nSpanish (Paraguay): Microsoft;\nSpanish (Peru): Microsoft;\nSpanish (Puerto Rico): Microsoft;\nSpanish (Uruguay): Microsoft;\nSpanish (Venezuela): Microsoft;\nSundanese (Indonesia): Microsoft;\nSwahili (Tanzania): Microsoft;\nTamil (India): Microsoft;\nTamil (Singapore): Microsoft;\nTamil (Sri Lanka): Microsoft;\nTelugu (India): Microsoft;\nThai: Microsoft;\nUrdu (India): Microsoft;\nUrdu (Pakistan): Microsoft;\nZulu (South Africa): Microsoft;\nUzbek: Microsoft;\nHebrew: (Israel): Microsoft;\nSpanish (Colombia): Microsoft;\nEstonian (Estonia): Microsoft;\nLatvian (Latvia): Microsoft.
\n","type":"text","disabled":true},{"key":"tts_voice","value":"","description":"String. Required if can_outbound_record is selected and outbound_record_notification_type is text-to-speech.
\nThe synthesized speech voice for outbound call recording notifications.
\nThe following options are available:
\nBengali (India):
\nEnglish (US):
\nEnglish (GB):
\nEnglish (AU):
\nEnglish (IN):
\nRussian:
\nGerman:
\nFrench:
\nFrench (CA):
\nItalian:
\nJapanese:
\nDutch:
\nTurkish:
\nKorean:
\nSwedish:
\nDanish:
\nSlovak:
\nPortuguese (BR):
\nPortuguese (PT):
\nPolish:
\nUkrainian:
\nVietnamese:
\nFilipino:
\nArabic:
\nCzech:
\nGreek:
\nFinnish:
\nHindi:
\nHungarian:
\nIndonesian:
\nNorwegian:
\nSpanish (Castilian):
\nSpanish (US):
\nKazakh (Kazakhstan):
\nSpanish (MX):
\nArabic (SA):
\nWelsh (UK):
\nIcelandic:
\nRomanian:
\nArabic:
\nChinese (Mandarin):
\nSpanish (LA):
\nAfrikaans (South Africa):
\nAmharic (Ethiopia):
\nArabic (Algeria):
\nArabic (Bahrein):
\nArabic (Egypt):
\nArabic (Iraq):
\nArabic (Jordan):
\nArabic (Kuwait):
\nArabic (Libya):
\nArabic (Morocco):
\nArabic (Qatar):
\nArabic (Syria):
\nArabic (Tunisia):
\nArabic (UAE):
\nArabic (Yemen):
\nAzerbaijani (Azerbaijan):
\nBangla (Bangladesh):
\nBulgarian:
\nBurmese (Myanmar):
\nCatalan (Spain):
\nChinese (Cantonese, Traditional):
\nChinese (Taiwanese Mandarin):
\nCroatian:
\nDutch (BE):
\nSpanish (Argentina):
\nNepali (Nepal):
\nEnglish (Canada):
\nEnglish (Hongkong):
\nEnglish (Ireland):
\nEnglish (Kenya):
\nEnglish (New Zeland):
\nEnglish (Nigeria):
\nEnglish (Philippines):
\nEnglish (South Africa):
\nEnglish (Tanzania):
\nFrench (Belgium):
\nFrench (Switzerland):
\nGalician (Spain):
\nGerman (Austria):
\nGerman (Switzerland):
\nGujarati (India):
\nIrish (Ireland):
\nJavanese (Indonesia):
\nKannada (India):
\nKazakh (Kazakhstan):
\nKhmer (Cambodia):
\nLao (Laos):
\nLithuanian (Lithuania):
\nMacedonian (North Macedonia):
\nMalay:
\nMalayalam (India):
\nMaltese (Malta):
\nMarathi (India):
\nPashto (Afghanistan):
\nPersian (Iran):
\nSerbian (Serbia, Cyrillic):
\nSinhala (Sri Lanka):
\nSlovenian:
\nSomali (Somalia):
\nSpanish (Bolivia):
\nSpanish (Chile):
\nSpanish (Costa Rica):
\nSpanish (Cuba):
\nSpanish (Dominican Republic):
\nSpanish (Ecuador):
\nSpanish (El Salvador):
\nSpanish (Equatorial Guinea):
\nSpanish (Guatemala):
\nSpanish (Honduras):
\nSpanish (Nicaragua):
\nSpanish (Panama):
\nSpanish (Paraguay):
\nSpanish (Peru):
\nSpanish (Puerto Rico):
\nSpanish (Uruguay):
\nSpanish (Venezuela):
\nSundanese (Indonesia):
\nSwahili (Tanzania):
\nTamil (India):
\nTamil (Singapore):
\nTamil (Sri Lanka):
\nTelugu (India):
\nThai:
\nUrdu (India):
\nUrdu (Pakistan):
\nZulu (South Africa):
\nUzbek:
\nHebrew: (Israel):
\nSpanish (Colombia):
\nEstonian (Estonia):
\nLatvian (Latvia):
\nString. Required if outbound_record_notification_type is tts.
\nThe outbound call recording notification text. The maximum length is 1500 characters.
\n","type":"text","disabled":true},{"key":"media_id","value":"1","description":"Integer. Required if outbound_record_notification_type is media.
\nThe audio file ID for outbound call recording notifications. Use the searchMedia method to retrieve the list of available media files.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/cc/updateSettings?domain={{domain}}","description":"Updates the general contact center settings.
\n","urlObject":{"protocol":"https","path":["api","v3","cc","updateSettings"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"01176cf8-975e-4b87-837d-9db77e70e9c0","name":"updateSettings","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your API token."},{"key":"can_inbound_calls","value":"true","type":"text","description":"Boolean. Required. True|false.\n\nSpecifies whether inbound calls are enabled for the contact center agents. The default setting is false."},{"key":"can_outbound_calls","value":"true","type":"text","description":"Boolean. Required. True|false.\n\nSpecifies whether outbound calls are enabled for the contact center agents. The default setting is false.\n\nIf can_outbound_calls=true, one of these parameters: outbound_phone_id, outbound_caller_id, or outbound_sip_number_id is required."},{"key":"outbound_phone_id","value":"1234","type":"text","description":"Integer. Optional.\n\nThe ID of the default phone number for outbound calls."},{"key":"outbound_sip_number_id","value":"","description":"Integer. Optional.\n\nThe ID of the default external phone number for outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls.","type":"text","disabled":true},{"key":"outbound_caller_id","value":"1234","type":"text","description":"Integer. Optional.\n\nThe default Caller ID for outbound calls.","disabled":true},{"key":"can_hold_record","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the system shoul play an audio recording while a customer is on hold.\n\nIf can_hold_record=true, the hold_media_id parameter is required.","disabled":true},{"key":"hold_media_id","value":"74","type":"text","description":"Integer. Optional. Required if can_hold_record=true.\n\nID of an audio recording the system plays when a call is on hold.","disabled":true},{"key":"can_internal_record","value":"true","description":"Boolean. Optional. \n\nSpecifies whether internal call recording is enabled for the contact center.","type":"text","disabled":true},{"key":"can_internal_calls","value":"true","description":"Boolean. Optional. \n\nSpecifies whether internal calls are enabled for the contact center agents. The default setting is null.","type":"text","disabled":true},{"key":"can_change_caller_id","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the contact center agents can change the Caller ID for outbound calls via the softphone.","type":"text","disabled":true},{"key":"hold_notification_enabled","value":"true","description":"Boolean. Optional.\n\nSpecifies whether hold notifications are enabled for the contact center.","type":"text","disabled":true},{"key":"hold_notification_time_sec","value":"30","description":"Integer. Optional. \n\nThe threshold time (in sec) when an agent receives a reminder that a customer is on hold. The default value is 30, minimum - 1, maximum - 120.","type":"text","disabled":true},{"key":"can_outbound_record","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether outbound call recording is enabled for the contact center.","disabled":true},{"key":"outbound_record_notification_type","value":"media","description":"String. Optional. \n\nThe outbound call recording notification type. The options are none, media file, or text-to-speech. The pattern is none|media|tts. The default setting is null.","type":"text","disabled":true},{"key":"outbound_record_notification_duration","value":"threeyears","type":"text","description":"String. Optional. \n\nOutbound call recording storage period. This is the period when outbound call recordings are available for listening and downloading in the Call history section. The options are default|sixmonth|oneyear|twoyears|threeyears.","disabled":true},{"key":"tts_language","value":"English (US) (Google)","description":"String. Required if outbound_record_notification_type=tts.\n\nThe synthesized speech language for outbound call recording notifications. The maximum length is 255 characters. \n\nThe following languages are available:\n\nBengali (India): Google, Microsoft\nEnglish (US): Google, Yandex, Amazon, IBM, Microsoft\nEnglish (GB): Google, Amazon, IBM, Microsoft\nEnglish (AU): Google, Amazon, Microsoft\nEnglish (IN): Google, Amazon, Microsoft\nRussian: Google, Yandex, Amazon, Tinkoff, Microsoft, SmartSpeech\nGerman: Google, Amazon, IBM, Microsoft\nFrench: Google, Amazon, IBM, Microsoft\nFrench (CA): Google, Amazon, Microsoft\nItalian: Google, Amazon, IBM, Microsoft\nJapanese: Google, Amazon, IBM, Microsoft\nDutch: Google, Amazon, IBM, Microsoft\nTurkish: Google, Yandex, Amazon, Microsoft\nKorean: Google, IBM, Microsoft\nSwedish: Google, Amazon,Microsoft\nDanish: Google, Amazon,Microsoft\nSlovak: Google, Microsoft\nPortuguese (BR): Google, Amazon, IBM, Microsoft\nPortuguese (PT): Google, Amazon, Microsoft\nPolish: Google, Amazon, Microsoft\nUkranian: Google, Microsoft\nVietnamese: Google, Microsoft\nFilipino: Google, Microsoft\nArabic: Google\nChinese (Mandarin): Google\nCzech: Google, Microsoft\nGreek: Google, Microsoft\nFinnish: Google, Microsoft\nHindi: Google, Amazon,Microsoft\nHungarian: Google, Microsoft\nIndonesian: Google, Microsoft\nNorwegian: Google, Amazon,Microsoft\nSpanish (Castilian): Google, Amazon, IBM, Microsoft\nSpanish (US): Google, Amazon, IBM, Microsoft\nKazakh (Kazakhstan): YandexV3\nSpanish (MX): Amazon, Microsoft\nArabic (SA): Amazon, Microsoft\nWelsh (UK): Amazon, Microsoft\nIcelandic: Amazon, Microsoft\nRomanian: Amazon, Microsoft\nArabic: IBM\nChinese (Mandarin): IBM, Microsoft\nSpanish (LA): IBM\nAfrikaans (South Africa): Microsoft\nAmharic (Ethiopia): Microsoft\nArabic (Algeria): Microsoft\nArabic (Bahrein): Microsoft\nArabic (Egypt): Microsoft\nArabic (Iraq): Microsoft\nArabic (Jordan): Microsoft\nArabic (Kuwait): Microsoft\nArabic (Libya): Microsoft\nArabic (Morocco): Microsoft\nArabic (Qatar): Microsoft\nArabic (Syria): Microsoft\nArabic (Tunisia): Microsoft\nArabic (UAE): Microsoft\nArabic (Yemen): Microsoft\nAzerbaijani (Azerbaijan): Microsoft\nBangla (Bangladesh): Microsoft\nBulgarian: Microsoft\nBurmese (Myanmar): Microsoft\nCatalan (Spain): Microsoft\nChinese (Cantonese, Traditional): Microsoft\nChinese (Taiwanese Mandarin): Microsoft\nCroatioan: Microsoft\nDutch (BE): Microsoft\nSpanish (Argentina): Microsoft\nNepali (Nepal): Microsoft\nEnglish (Canada): Microsoft\nEnglish (Hongkong): Microsoft\nEnglish (Ireland): Microsoft\nEnglish (Kenya): Microsoft\nEnglish (New Zeland): Microsoft\nEnglish (Nigeria): Microsoft\nEnglish (Philippines): Microsoft\nEnglish (South Africa): Microsoft\nEnglish (Tanzania): Microsoft\nEnglish (Singapore): Google, Microsoft, Deepgram\nFrench (Belgium): Microsoft\nFrench (Switzerland): Microsoft\nGalician (Spain): Microsoft\nGerman (Austria): Microsoft\nGerman (Switzerland): Microsoft\nGujarati (India): Microsoft\nIrish (Ireland): Microsoft\nJavanese (Indonesia): Microsoft\nKannada (India): Microsoft\nKazakh (Kazakhstan): Microsoft\nKhmer (Cambodia): Microsoft\nLao (Laos): Microsoft\nLithuanian (Lithuania): Microsoft\nMacedonian (North Macedonia): Microsoft\nMalay: Microsoft\nMalayalam (India): Microsoft\nMaltese (Malta): Microsoft\nMarathi (India): Microsoft\nMongolian (Mongolia): Google, Microsoft\nPashto (Afganistan): Microsoft\nPersian (Iran): Microsoft\nSerbian (Serbia, Cyrillic): Microsoft\nSinhala (Sri Lanka): Microsoft\nSlovenian: Microsoft\nSomali (Somalia): Microsoft\nSpanish (Bolivia): Microsoft\nSpanish (Chile): Microsoft\nSpanish (Costa Rica): Microsoft\nSpanish (Cuba): Microsoft\nSpanish (Dominican Republic): Microsoft\nSpanish (Ecuador): Microsoft\nSpanish (El Salvador): Microsoft\nSpanish (Equatorial Guinea): Microsoft\nSpanish (Guatemala): Microsoft\nSpanish (Honduras): Microsoft\nSpanish (Nicaragua): Microsoft\nSpanish (Panama): Microsoft\nSpanish (Paraguay): Microsoft\nSpanish (Peru): Microsoft\nSpanish (Puerto Rico): Microsoft\nSpanish (Uruguay): Microsoft\nSpanish (Venezuela): Microsoft\nSundanese (Indonesia): Microsoft\nSwahili (Tanzania): Microsoft\nTamil (India): Microsoft\nTamil (Singapore): Microsoft\nTamil (Sri Lanka): Microsoft\nTelugu (India): Microsoft\nThai: Microsoft\nUrdu (India): Microsoft\nUrdu (Pakistan): Microsoft\nZulu (South Africa): Microsoft\nUzbek: Microsoft\nHebrew: (Israel): Microsoft\nSpanish (Colombia): Microsoft\nEstonian (Estonia): Microsoft\nLatvian (Latvia): Microsoft","type":"text","disabled":true},{"key":"tts_voice","value":"Standard_B","description":"String. Required if outbound_record_notification_type=tts.\n\nThe synthesized speech voice for outbound call recording notifications. The maximum length is 255 characters.\n\nThe following options are available:\n\nBengali (India):\n\nGoogle: Wavenet_A, Wavenet_B (neutral voices), Standard_A, Standard_B (common voices)\nMicrosoft: Tanishaa, Bashkar (neutral voices)\nEnglish (US):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E, Wavenet_F (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices)\nYandex: Alyss, Nick (common voices)\nAmazon: Ivy, Joanna, Kendra, Kimberly, Salli, Joey,Justin, Matthew (neutral voices), Joanna, Joey (common voices)\nIBM: Allison, Emily, Henry, Kevin, Lisa, Michael,Olilia (neutral voices), Allison, Lisa, Michael (common voices)\nMicrosoft: Amber, Ashley, Cora, Elizabeth, Michelle, Monica, Sara, Ana, Brandon, Christopher, Eric, Jacob, Aria, Guy (neutral voices)\nEnglish (GB):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nAmazon: Amy, Emma, Brian (neutral voices), Amy, Brian (common voices)\nIBM: Kate (neutral voice), Kate (common voice)\nMicrosoft: Sonia, Ryan, Libby Mia (neutral voices)\nEnglish (AU):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nAmazon: Nicole, Russel (common voices)\nMicrosoft: William, Natasha (neutral voices)\nEnglish (IN):\n-Google: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_B, Standard_C, Standard_A (common voices)\n\nAmazon: Aditi (common voice)\nMicrosoft: Prabhat, Neerja (neutral voices)\nRussian:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices)\nYandex: Alena, Filipp (neutral voices), Jane, Omazh, Zahar, Ermil (common voices)\nAmazon: Maxim, Tatyana (common voices)\nTinkoff: Male, Female (common voices)\nMicrosoft: Dariya, Svetlana, Dmitry (neutral voices)\nSmartSpeech: Natalia, Boris, Marfa, Taras, Alexandra, Sergey (common voices)\nGerman:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_E (common voices)\nAmazon: Marlene, Hans (common voices)\nIBM: Birgit, Dieter, Erika (neutral voices), Birgit, Dieter (common voices)\nMicrosoft: Conrad, Katja (neutral voices)\nFrench:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_E (common voices)\nAmazon: Celine, Mathieu (common voices)\nIBM: Renee (neutral voice), Renee (common voice)\nMicrosoft: Henri, Denise (neutral voices)\nFrench (CA):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nAmazon: Chantal (common voice)\nMicrosoft: Antonie, Jean, Sylvie (neutral voices)\nItalian:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nAmazon: Carla, Giorgio (common voices)\nIBM: Francesca (neutral voice), Francesca (common voice)\nMicrosoft: Isabella, Diego, Elsa (neutral voices)\nJapanese:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nAmazon: Mizuki, Takumi (common voices)\nIBM: Emi (neutral voice), Emi (common voice)\nMicrosoft: Keita, Nanami (neutral voices)\nDutch:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices)\nAmazon: Lotte, Rubin (common voices)\nIBM: Emi (neutral voice), Emi (common voice)\nMicrosoft: Fenna, Maarten, Colette (neutral voices)\nTurkish:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_B, Standard_C, Standard_D, Standard_E (common voices)\nAmazon: Lotte, Rubin (common voices)\nYandex: Sila Erkan, Erkan Yavas\nAmazon: Filiz (common voice)\nMicrosoft: Ahmet, Emel (neutral voices)\nKorean:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nIBM: Youngmi, Yuna (common voices)\nMicrosoft: InJoon, SunHi (neutral voices)\nSwedish:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nAmazon: Astrid (common voice)\nMicrosoft: Sopie, Mattias, Hillevi (neutral voices)\nDanish:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nAmazon: Naja, mads (common voices)\nMicrosoft: Jeppe, Christel\nSlovak:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Viktoria, Lukas (neutral voices)\nPortuguese (BR):\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nAmazon: Camila (neutral voice), Viktoria, Ricardo (common voices)\nIBM: Isabela (neutral voice), Isabela (common voice)\nMicrosoft: Antonio, Francisca (neutral voices)\nPortuguese (PT):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_B, Standard_C, Standard_D, Standard_A (common voices)\nAmazon: Ines, Cristiano (common voices)\nMicrosoft: Raquel, Duarte, Fernanda (neutral voices)\nPolish:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices)\nAmazon: Maja, Jan (common voices)\nMicrosoft: Agnieszka, Marek, Zofia (neutral voices)\nUkranian:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Polina, Ostap (neutral voices)\nVietnamese:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices)\nMicrosoft: HoaiMy, NamMinh (neutral voices)\nFilipino:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Blessica, Angelo (neutral voices)\nArabic:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices)\nChinese (Mandarin):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D (common voices)\nCzech:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Vlasta, Antonin (neutral voices)\nGreek:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Athina, Nestoras (neutral voices)\nFinnish:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Harri, Noora (neutral voices)\nHindi:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_B, Standard_C, Standard_A (common voices)\nAmazon: Aditi (common voice)\nMicrosoft: Madhur, Swara (neutral voices)\nHungarian:\n\nGoogle: Wavenet_A (neutral voice), Standard_A (common voice)\nMicrosoft: Noemi, Tamas (neutral voices)\nIndonesian:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_B, Standard_C, Standard_A (common voices)\nMicrosoft: Gadis, Ardi (neutral voices)\nNorwegian:\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C, Wavenet_D, Wavenet_E (neutral voices), Standard_A, Standard_B, Standard_C, Standard_D, Standard_E (common voices)\nAmazon: Liv (common voice)\nMicrosoft: Pernille, Finn, Iselin (neutral voices)\nSpanish (Castilian):\n\nGoogle: Wavenet_B, Wavenet_C, Wavenet_D (neutral voices), Standard_A (common voice)\nAmazon: Conchita, Enrique (common voices)\nIBM: Enrique, Laura (neutral voices), Enrique, Laura (common voices)\nMicrosoft: Elvira (neutral voice)\nSpanish (US):\n\nGoogle: Wavenet_A, Wavenet_B, Wavenet_C (neutral voices), Standard_A, Standard_B, Standard_C (common voices)\nAmazon: Lupe (neutral voice), Penelope, Miguel (common voices)\nIBM: Sofia (neutral voice), Sofia (common voice)\nMicrosoft: Alonso (neutral voice)\nKazakh (Kazakhstan):\n\nYandexV3: Amira (common voice)\nSpanish (MX):\n\nAmazon: Mia (common voice)\nMicrosoft: Jorge, Dalia (neutral voices)\nArabic (SA):\n\nAmazon: Zeina (common voice)\nMicrosoft: Hamed, Zariyah (neutral voices)\nWelsh (UK):\n\nAmazon: Gwyneth, Geraint (common voices)\nMicrosoft: Nia, Aled (neutral voices)\nIcelandic:\n\nAmazon: Dora, Carl (common voices)\nMicrosoft: Gudrun, Gunnar (neutral voices)\nRomanian:\n\nAmazon: Carmen (common voice)\nMicrosoft: Alina, Emil (neutral voices)\nArabic:\n\nIBM: Omar (common voice)\nChinese (Mandarin):\n\nIBM: LiNa, WangWei, ZhangJing (common voices)\nMicrosoft: Xiaochen, Xiaohan, Xiaomo, Xiaoqiu, Xiaorui, Xiaoshuang, Xiaoxuan, Xiaoyan, Yunxi, Xiaoxiao, Xiaoyou, Yunyang, Yunye (neutral voices)\nSpanish (LA):\n\nIBM: Sofia (neutral voice), Sofia (common voice)\nAfrikaans (South Africa):\n\nMicrosoft: Adri, Willem (neutral voices)\nAmharic (Ethiopia):\n\nMicrosoft: Mekdes, Ameha (neutral voices)\nArabic (Algeria):\n\nMicrosoft: Amina, Izmael (neutral)\nArabic (Bahrein):\n\nMicrosoft: Laila, Ali (neutral)\nArabic (Egypt):\n\nMicrosoft: Shakir, Salma (neutral voices)\nArabic (Iraq):\n\nMicrosoft: Rana, Bassel (neutral voices)\nArabic (Jordan):\n\nMicrosoft: Sana, Taim (neutral voices)\nArabic (Kuwait):\n\nMicrosoft: Noura, Fahed (neutral voices)\nArabic (Libya):\n\nMicrosoft: Iman, Omar (neutral voices)\nArabic (Morocco):\n\nMicrosoft: Mouna, Jamal (neutral voices)\nArabic (Qatar):\n\nMicrosoft: Amal, Moaz (neutral voices)\nArabic (Syria):\n\nMicrosoft: Amany, Laith (neutral voices)\nArabic (Tunisia):\n\nMicrosoft: Reem, Hedi (neutral voices)\nArabic (UAE):\n\nMicrosoft: Fatima, Hamdan (neutral voices)\nArabic (Yemen):\n\nMicrosoft: Maryam, Saleh (neutral voices)\nAzerbaijani (Azerbaijan):\n\nMicrosoft: Babek, Banu (neutral voices)\nBangla (Bangladesh):\n\nMicrosoft: Nabanita, Pradeep (neutral voices)\nBulgarian:\n\nMicrosoft: Kalina, Borislav (neutral voices)\nBurmese (Myanmar):\n\nMicrosoft: Nilar, Thiha (neutral voices)\nCatalan (Spain):\n\nMicrosoft: Joana, Enric, Alba (neutral voices)\nChinese (Cantonese, Traditional):\n\nMicrosof: HiuMaan, WanLung, HiuGaai (neutral voices)\nChinese (Taiwanese Mandarin):\n\nMicrosoft: HsiaoChen, YunJhe, HsiaoYu (neutral voices)\nCroatioan:\n\nMicrosoft: Gabrijela, Srecko (neutral voices)\nDutch (BE):\n\nMicrosoft: Dena, Arnaud (neutral voices)\nSpanish (Argentina):\n\nMicrosoft: Elena, Tomas (neutral voices)\nNepali (Nepal):\n\nMicrosoft: Sagar, Hemkala (neutral voices)\nEnglish (Canada):\n\nMicrosoft: Liam, Clara (neutral voices)\nEnglish (Hongkong):\n\nMicrosoft: Yan, Sam (neutral voices)\nEnglish (Ireland):\n\nMicrosoft: Emily, Connor (neutral voices)\nEnglish (Kenya):\n\nMicrosoft: Asilia, Chilemba (neutral voices)\nEnglish (New Zeland):\n\nMicrosoft: Molly, Mitchell (neutral voices)\nEnglish (Nigeria):\n\nMicrosoft: Ezinne, Abeo (neutral voices)\nEnglish (Philippines):\n\nMicrosoft: Rosa, James (neutral voices)\nEnglish (South Africa):\n\nMicrosoft: Leah, Luke (neutral voices)\nEnglish (Tanzania):\n\nMicrosoft: Imani, Elimu (neutral voices)\nFrench (Belgium):\n\nMicrosoft: Charlie, Gerard (neutral voices)\nFrench (Switzerland):\n\nMicrosoft: Ariane, Fabrice (neutral voices)\nGalician (Spain):\n\nMicrosoft: Sabela, Roi (neutral voices)\nGerman (Austria):\n\nMicrosoft: Ingrid, Jonas (neutral voices)\nGerman (Switzerland):\n\nMicrosoft: Jan (neutral voice)\nGujarati (India):\n\nMicrosoft: Dhwani, Niranjan (neutral voices)\nIrish (Ireland):\n\nMicrosoft: Orla, Colm (neutral voices)\nJavanese (Indonesia):\n\nMicrosoft: Siti, Dimas (neutral voices)\nKannada (India):\n\nMicrosoft: Sapna, Gagan (neutral voices)\nKazakh (Kazakhstan):\n\nMicrosoft: Aigul, Daulet (neutral voices)\nKhmer (Cambodia):\n\nMicrosoft: Sreymom, Piseth (neutral voices)\nLao (Laos):\n\nMicrosoft: Keomany, Chanthavong (neutral voices)\nLithuanian (Lithuania):\n\nMicrosoft: Ona, Leonas (neutral voices)\nMaceonian (North Macedonia):\n\nMicrosoft: Marija, Aleksandr (neutral voices)\nMalay:\n\nMicrosoft: Yasmin, Osman (neutral voices)\nMalayalam (India):\n\nMicrosoft: Sobhana, Midhun (neutral voices)\nMaltese (Malta):\n\nMicrosoft: Grace, Joseph (neutral voices)\nMarathi (India):\n\nMicrosoft: Aarohi, Manohar (neutral voices)\nPashto (Afganistan):\n\nMicrosoft: Latifa, GulNawaz (neutral voices)\nPersian (Iran):\n\nMicrosoft: Dilara, Farid (neutral voices)\nSerbian (Serbia, Cyrillic):\n\nMicrosoft: Sophie, Nicholas (neutral voices)\nSinhala (Sri Lanka):\n\nMicrosoft: Thilini, Sameera (neutral voices)\nSlovenian:\n\nMicrosoft: Petra, Rok (neutral voices)\nSomali (Somalia):\n\nMicrosoft: Ubax, Muuse (neutral voices)\nSpanish (Bolivia):\n\nMicrosoft: Sofia, Marcelo (neutral voices)\nSpanish (Chile):\n\nMicrosoft: Catalina, Lorenzo (neutral voices)\nSpanish (Costa Rica):\n\nMicrosoft: Maria, Juan (neutral voices)\nSpanish (Cuba):\n\nMicrosoft: Belkys, Manuel (neutral voices)\nSpanish (Dominican Republic):\n\nMicrosoft: Ramona, Emilio (neutral voices)\nSpanish (Ecuador):\n\nMicrosoft: Andrea, Luis (neutral voices)\nSpanish (El Salvador):\n\nMicrosoft: Lorena, Rodrigo (neutral voices)\nSpanish (Equatorial Guinea):\n\nMicrosoft: Teresa, Javier (neutral voices)\nSpanish (Guatemala):\n\nMicrosoft: Marta, Andres (neutral voices)\nSpanish (Honduras):\n\nMicrosoft: Karla, Carlos (neutral voices)\nSpanish (Nicaragua):\n\nMicrosoft: Yolanda, Federico (neutral voices)\nSpanish (Panama):\n\nMicrosoft: Margarita, Roberto (neutral voices)\nSpanish (Paraguay):\n\nMicrosoft: Tania, Mario (neutral voices)\nSpanish (Peru):\n\nMicrosoft: Camila, Alex (neutral voices)\nSpanish (Puerto Rico):\n\nMicrosoft: Karina, Victor (neutral voices)\nSpanish (Uruguay):\n\nMicrosoft: Valentina, Mateo (neutral voices)\nSpanish (Venezuela):\n\nMicrosoft: Paola, Sebastian (neutral voices)\nSundanese (Indonesia):\n\nMicrosoft: Tuti, Jajang (neutral voices)\nSwahili (Tanzania):\n\nMicrosoft: Rehema, Daudi (neutral voices)\nTamil (India):\n\nMicrosoft: Pavalli, Valluvar (neutral voices)\nTamil (Singapore):\n\nMicrosoft: Venba, Anbu (neutral voices)\nTamil (Sri Lanka):\n\nMicrosoft: Saranya, Kumar (neutral voices)\nTelugu (India):\n\nMicrosoft: Shruti, Mohan (neutral voices)\nThai:\n\nMicrosoft: Premwadee, Niwat, Achara (neutral voices)\nUrdu (India):\n\nMicrosoft: Gul, Salman (neutral voices)\nUrdu (Pakistan):\n\nMicrosoft: Uzma, Asad (neutral voices)\nZulu (South Africa):\n\nMicrosoft: Thando, Themba (neutral voices)\nUzbek:\n\nMicrosoft: Madina, Sardor (neutral voices)\nHebrew: (Israel):\n\nMicrosoft: Avri, Hila (neutral voices)\nSpanish (Colombia):\n\nMicrosoft: Gonzalo, Salome (neutral voices)\nEstonian (Estonia):\n\nMicrosoft: Anu, Kert (neutral voices)\nLatvian (Latvia):\n\nMicrosoft: Everita, Nils (neutral voices)","type":"text","disabled":true},{"key":"tts_text","value":"Please be advised that the call is being recorded.","description":"String. Required if outbound_record_notification_type=tts.\n\nThe outbound call recording notification text. The maximum length is 1500 characters. ","type":"text","disabled":true},{"key":"media_id","value":"1","description":"Integer. Required if outbound_record_notification_type=media.\n\nThe audio recording ID for outbound call recording notifications.","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/cc/updateSettings?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","cc","updateSettings"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 13 Apr 2023 05:34:03 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"5924475e8345672f8be5b2af13791738"},{"key":"Vary","value":"Accept"},{"key":"Set-Cookie","value":"_csrf=0cf88b396fde8d24f2bf48511a9198d67c35aeb9efd7d4676a1ab747ca2d26eda%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%224RKWnVRArMaDcNDaHKVHg_ipyIKbsG30%22%3B%7D; path=/; HttpOnly; SameSite=Lax"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"8b21dfff-81f3-4f91-acdf-983d5299d8bd"},{"name":"notify","id":"5c8efbfd-641f-4be4-91d5-b1a90cae304f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"user_ids","type":"text","value":"[2517]","description":"JSON integer array. Required.
\nThe user IDs to receive a notification. Use the searchUsers method to retrieve the list of available user IDs.
\n"},{"key":"message","value":"Please make sure you are in the Ready status.","type":"text","description":"String. Required.
\nYour message. The maximum length is 100 characters.
\n"}]},"url":"https://{{host}}/api/v3/cc/notify?domain={{domain}}","description":"Sends a notification to particular contact center users.
\n","urlObject":{"protocol":"https","path":["api","v3","cc","notify"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"80725402-3dfd-4afe-9543-d28dfe60c871","name":"notify","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"Your API token."},{"key":"user_ids","type":"text","value":"[2517]","description":"Json integer array. Required.\n\nThe IDs of the users who will receive a notification."},{"key":"message","value":"Please make sure you are in the Ready status.","type":"text","description":"String. Required. \n\nYour message. The maximum length is 100 characters."}]},"url":{"raw":"https://{{host}}/api/v3/cc/notify?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","cc","notify"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 13 Apr 2023 05:34:31 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"3afeb95229ba00b3cd7da48bfaa35894"},{"key":"Vary","value":"Accept"},{"key":"Set-Cookie","value":"_csrf=f23036c770ab6c3bddd5b083496912188f5a5711372620f2350983324ebbc6d0a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22HIUYWKeC28MCZRbDHefdf4IqAWnBsuAC%22%3B%7D; path=/; HttpOnly; SameSite=Lax"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"5c8efbfd-641f-4be4-91d5-b1a90cae304f"},{"name":"updateDialingSettings","id":"a8acc461-d9b2-4786-9eb2-75cab5c86622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"agent_dialing_max_waiting_time_sec","value":"15","type":"text","description":"Integer. Required.
\nThe longest time (in seconds) a customer waits to be connected to a contact center agent. The minimum value is 10, maximum - 60.
\n"},{"key":"agent_dialing_media_enabled","value":"false","type":"text","description":"Boolean. Required.
\nSpecifies whether the system plays an audio recording while customers are dialing contact center agents. The default setting is false.
\n"},{"key":"agent_dialing_media_id","value":"","type":"text","description":"Integer. Required if agent_dialing_media_enabled is true.
\nThe audio recording ID the system plays when customers are dialing contact center agents. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"group_dialing_media_enabled","value":"false","type":"text","description":"Boolean. Required.
\nSpecifies whether the system plays an audio recording while customers are dialing contact center agent groups. The default setting is false.
\n"},{"key":"group_dialing_media_id","value":"","type":"text","description":"Integer. Required if group_dialing_media_enabled is true.
\nThe audio recording ID the system plays when customers are dialing contact center agent groups. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true},{"key":"queue_dialing_media_enabled","value":"false","type":"text","description":"Boolean. Required.
\nSpecifies whether the system plays an audio recording while customers are dialing contact center queues. The default setting is false.
\n"},{"key":"queue_dialing_media_id","value":"","type":"text","description":"Integer. Required if queue_dialing_media_enabled is true.
\nThe audio recording ID the system plays when customers are dialing contact center queues. Use the searchMedia method to retrieve the list of available media files.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/cc/updateDialingSettings?domain={{domain}}","description":"Updates the contact center dialing settings.
\n","urlObject":{"protocol":"https","path":["api","v3","cc","updateDialingSettings"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"4b761e19-1915-4b5c-b105-a64338bf1939","name":"updateDialingSettings","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"Your API token."},{"key":"agent_dialing_max_waiting_time_sec","value":"15","type":"text","description":"Required, integer. Min=10 max=60.\n\nMaximum waiting time."},{"key":"agent_dialing_media_enabled","value":"false","type":"text","description":"Required. True|false, default=false.\n\nEnable audio playback when dialing all users."},{"key":"agent_dialing_media_id","value":"299","type":"text","description":"Optional, integer.\n\nID of an audio recording to play when dialing all users.\n\nRequired if agent_dialing_media_enabled=true.","disabled":true},{"key":"group_dialing_media_enabled","value":"false","type":"text","description":"Required. True|false, default=false.\n\nEnable audio playback when dialing all agent groups."},{"key":"group_dialing_media_id","value":"","type":"text","description":"Optional, integer.\n\nID of an audio recording to play when dialing agent groups.\n\nRequired if group_dialing_media_enabled=true.","disabled":true},{"key":"queue_dialing_media_enabled","value":"false","type":"text","description":"Required. True|false, default=false.\n\nEnable audio playback when dialing all queues."},{"key":"queue_dialing_media_id","value":"","type":"text","description":"Optional, integer.\n\nID of an audio recording to play when dialing queues.\nRequired if queue_dialing_media_enabled=true.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/cc/updateDialingSettings?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","cc","updateDialingSettings"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 07:48:21 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"799a98145ad91c031a9e7fdfb9152c3a"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"a8acc461-d9b2-4786-9eb2-75cab5c86622"}],"id":"3ac7a955-7484-47f1-ba16-c607038e9e13","description":"This folder contains actions you may need to update your contact center settings and get agent and queue statistics.
\n","_postman_id":"3ac7a955-7484-47f1-ba16-c607038e9e13"},{"name":"cti","item":[{"name":"makeCall","id":"0fae9200-1887-4b0c-ba8f-7c86a099540c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"number","value":"147428888888","description":"String. Required.
\nThe phone number to be called.
\n","type":"text"},{"key":"user_id","value":"14526","description":"Integer. Required.
\nThe ID of the user who should start the call.
\n","type":"text"},{"key":"callerid","value":"147429999999","description":"String. Optional.
\nThe Caller ID for the outbound call.
\n","type":"text"},{"key":"variables","value":"[{\"variable1\": \"value1\"}, {\"variable2\": \"value2\"}]","description":"JSON object. Optional.
\n","type":"text"}]},"url":"https://{{cti_host}}/{{domain}}/makeCall","description":"Places a new call to a destination number you specify.
\n","urlObject":{"protocol":"https","path":["{{domain}}","makeCall"],"host":["{{cti_host}}"],"query":[],"variable":[]}},"response":[{"id":"dc72b354-4593-4b87-84bd-bd0f2cf6104f","name":"makeCall","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"number","value":"147428888888","description":"String. Required.\n\nThe phone number to be called.","type":"text"},{"key":"user_id","value":"14526","description":"Integer. Required.\n\nThe ID of the user who should start the call.","type":"text"},{"key":"callerid","value":"147429999999","description":"String. Optional.\n\nThe Caller ID for the outbound call.","type":"text"},{"key":"caller_id","value":"111111111","description":"String. Optional.\n\nThe identifier of the Caller ID for the outbound call.","type":"text"},{"key":"variables","value":"[{\"variable1\": \"value1\"}, {\"variable2\": \"value2\"}]","description":"JSON object. Optional.","type":"text"}]},"url":"https://{{cti_host}}/{{domain}}/makeCall"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 15 Nov 2023 09:23:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"0fae9200-1887-4b0c-ba8f-7c86a099540c"},{"name":"makeTransfer","id":"c53007df-9503-473d-b864-21bdab89803b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"user_id","value":"4651","description":"Integer. Required.
\nThe ID of the user who transfers the call.
\n"},{"type":"text","key":"call_id","value":"325465","description":"Integer. Required.
\nThe ID of the call being transferred.
\n"},{"type":"text","key":"transfer_type","value":"blind","description":"String. Required.
\nTransfer method. The options are blind | attended.
\n"},{"type":"text","key":"direction_type","value":"pstn","description":"String. Required.
\nTransfer destination: sip, external number, or extension. The options are sip | pstn | extension.
\n"},{"type":"text","key":"extension_transfer_data","value":"{\"extension_number\": \"123\"}","description":"JSON. Optional.
\nRequired data if the call is transferred to an extension number
\nExample: ({\"extension_number\": \"123\"}).
\n","disabled":true},{"type":"text","key":"pstn_transfer_data","value":"{\"number\": \"147231234567\", \"caller_id\": \"147291234567\"}","description":"JSON. Optional.
\nRequired data if the call is transferred to an external number (destination number and Caller ID).
\nExample: ({\"number\": \"14721234567\", \"caller_id\": \"14721234567\"}).
\n"},{"type":"text","key":"sip_transfer_data","value":"{\"to\": \"sip:tonumber@sip\", \"from\": \"sip:fromnumber@sip\"}","description":"JSON. Optional.
\nRequired data if the call is transferred to a SIP number.
\nExample: ({\"to\": \"sip:tonumber@sip\", \"from\": \"sip:fromnumber@sip\"}).
\n","disabled":true}]},"url":"https://{{cti_host}}/transferCall?domain={{domain}}","description":"Transfers a call to a SIP, external, or extension number you specify.
\n","urlObject":{"protocol":"https","path":["transferCall"],"host":["{{cti_host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"09169fcb-a365-4b9d-a1a4-39ea7222cd7a","name":"makeTransfer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."},{"type":"text","key":"user_id","value":"4651","description":"Integer. Required.\n\nThe ID of the user who transfers the call."},{"type":"text","key":"call_id","value":"325465","description":"Integer. Required.\n\nThe ID of the call being transferred."},{"type":"text","key":"transfer_type","value":"blind","description":"String. Required.\n\nTransfer method. The options are blind | attended."},{"type":"text","key":"direction_type","value":"pstn","description":"String. Required.\n\nTransfer destination: sip, external number, or extension. The options are sip | pstn | extension."},{"type":"text","key":"extension_transfer_data","value":"{\"extension_number\": \"123\"}","description":"JSON. Optional.\n\nRequired data if the call is transferred to an extension number \n\nExample: ({\"extension_number\": \"123\"}).","disabled":true},{"type":"text","key":"pstn_transfer_data","value":"{\"number\": \"147231234567\", \"caller_id\": \"147291234567\"}","description":"JSON. Optional.\n\nRequired data if the call is transferred to an external number (destination number and Caller ID). \n\nExample: ({\"number\": \"14721234567\", \"caller_id\": \"14721234567\"})."},{"type":"text","key":"sip_transfer_data","value":"{\"to\": \"sip:tonumber@sip\", \"from\": \"sip:fromnumber@sip\"}","description":"JSON. Optional.\n\nRequired data if the call is transferred to a SIP number.\n\nExample: ({\"to\": \"sip:tonumber@sip\", \"from\": \"sip:fromnumber@sip\"}).","disabled":true}]},"url":{"raw":"https://{{cti_host}}/transferCall?domain={{domain}}","protocol":"https","host":["{{cti_host}}"],"path":["transferCall"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"c53007df-9503-473d-b864-21bdab89803b"}],"id":"4beaccba-71f6-4257-a169-0362e4a21ff8","description":"This folder contains actions you may need to send requests to the CTI server.
\n","_postman_id":"4beaccba-71f6-4257-a169-0362e4a21ff8"},{"name":"dnc","item":[{"name":"addDncContacts","id":"b2b441e4-50da-470e-aad1-005a96e6f0ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"436","type":"text","description":"Integer. Required.
\nThe DNC list ID. Use the searchDncList method to retrieve the list of available DNC lists.
\n"},{"key":"contacts","value":"[\"12056058660\", \"12065009424\"]","description":"JSON array. Required.
\nThe contacts you want add to the DNC list (maximum 50 contacts).
\n","type":"text"},{"key":"comment","value":"New prospects","type":"text","description":"String. Optional.
\nAny additional comments for the new contacts.
\n"},{"key":"reject_invalid_numbers","value":"none","description":"String. Optional.
\nContacts' validation. The options are reject_all | reject_invalid_only | none. The default setting is none.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/dnc/addDncContacts?domain={{domain}}","description":"Adds a contact to a DNC list.
\n","urlObject":{"protocol":"https","path":["api","v3","dnc","addDncContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"8879c54b-3fed-4e49-84ae-b871685ae4ec","name":"addDncContacts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"436","type":"text"},{"key":"contacts","value":"[\"12056058660\", \"12065009424\"]","type":"text"},{"key":"comment","value":"New prospects","type":"text"},{"key":"reject_invalid_numbers","value":"none","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/dnc/addDncContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","dnc","addDncContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 13:38:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 436,\n \"contacts_count\": 2\n }\n}"}],"_postman_id":"b2b441e4-50da-470e-aad1-005a96e6f0ed"},{"name":"searchDncContacts","id":"72a02d22-a86e-4fc2-b05e-71f6d0036a90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"number","value":"51","type":"text","description":"String. Optional.
\nThe particular DNC contact number to filter. The maximum length is 15 characters.
\n","disabled":true},{"key":"id","value":"26402","type":"text","description":"Integer. Optional.
\nThe particular DNC contact ID to filter. The maximum length is 2147483647 characters, the minimum is 1.
\n","disabled":true},{"key":"list_id","value":"436","type":"text","description":"Integer. Optional.
\nThe particular DNC list ID to filter. The maximum length is 2147483647 characters, the minimum is 1.
\n"},{"key":"with_agent_campaign","value":"1","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report includes PDS campaigns. The options are 1|0|true|false.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/dnc/searchDncContacts?domain={{domain}}","description":"Retrieves a list of DNC contacts.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","dnc","searchDncContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"49c4013e-3379-455c-b62d-ab397440d655","name":"searchDncContacts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"number","value":"","type":"text","description":"String. Optional.\n\nThe particular DNC list contact to filter. The maximum length is 15 characters.","disabled":true},{"key":"list_id","value":"436","type":"text","description":"Integer. Optional.\n\nThe particular DNC list ID to filter. The maximum length is 2147483647 characters, the minimum is 1."},{"key":"with_agent_campaign","value":"1","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes PDS campaigns. The options are 1|0|true|false.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/dnc/searchDncContacts?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","dnc","searchDncContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 13:44:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4eddf0373eac00ac6adb72be80ce468e"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"2"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"id","value":"459206","description":"Integer. Required.
\nThe DNC contact ID. Use the searchDncContacts method to retrieve the list of available DNC contacts.
\n","disabled":true},{"type":"text","key":"number","value":"12056058660","description":"String. Optional.
\nThe DNC contacl number.
\n"},{"key":"list_id","value":"436","description":"Integer. Optional (required when the number parameter is not empty and the id parameter is empty).
\nThe DNC list ID. Use the searchDncList method to retrieve the list of available DNC lists.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/dnc/deleteDncContact?domain={{domain}}","description":"Removes a DNC contact.
\n","urlObject":{"protocol":"https","path":["api","v3","dnc","deleteDncContact"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"9c87f418-78f6-4305-acd6-3db604580fb6","name":"deleteDncContact","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"Your access token."},{"type":"text","key":"id","value":"459206","description":"Integer. Required.\n\nThe DNC contact ID you want to delete. Use the searchDncContacts method to retrieve the list of available DNC contacts.","disabled":true},{"type":"text","key":"number","value":"12056058660","description":"String. Optional.\n\nThe DNC contacl number."},{"key":"list_id","value":"436","description":"Integer. Optional (required when the number parameter is not empty and the id parameter is empty).\n\nThe DNC list ID.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/dnc/deleteDncContact?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","dnc","deleteDncContact"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 13:50:55 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"284510356eb452ef2372f70b8cb4f68d"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"30999755-6e0a-476b-994a-f0ce7221f8a4"},{"name":"searchDncList","id":"fbae542d-0eca-4bc8-a902-bc89011efdef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"7","description":"Integer. Optional.
\nThe particular DNC list ID to filter.
\n","type":"text","equals":true,"disabled":true},{"key":"title","value":"Customers out of the coverage area","type":"text","equals":true,"description":"String. Optional.
\nThe particular DNC list name to filter.
\n","disabled":true},{"key":"with_agent_campaigns","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include DNC lists with the information about the PDS campaigns they are attached to. If a DNC list is not attached to a campaign, the campaign parameter is empty. The options are true|false.
\n","type":"text","equals":true}]},"url":"https://{{host}}/api/v3/dnc/searchDncList?domain={{domain}}","description":"Retrieves a list of DNC lists.
\nIf you define specific query parameters, the request returns only the DNC lists that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","dnc","searchDncList"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"bdd67cdf-169b-4748-a6bd-bc7638691ace","name":"searchDncList","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."},{"type":"text","key":"id","value":"459","description":"Integer. Optional.\n\nThe particular DNC list ID to filter.","disabled":true},{"key":"title","value":"Customers out of the coverage area","type":"text","equals":true,"description":"String. Optional.\n\nThe particular DNC list name to filter.","disabled":true},{"key":"with_agent_campaigns","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report should include DNC lists with the information about the PDS campaigns they are attached to. If a DNC list is not attached to a campaign, the campaign parameter is empty. The options are true|false.","type":"text","equals":true}]},"url":{"raw":"https://{{host}}/api/v3/dnc/searchDncList?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","dnc","searchDncList"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 13:50:55 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"284510356eb452ef2372f70b8cb4f68d"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 459,\n \"title\": \"Customers out of the coverage area\",\n \"country\": null,\n \"description\": \"\",\n \"is_global\": false,\n \"create_date\": \"2024-06-05 12:57:41\",\n \"edit_date\": null,\n \"contacts_count\": 0,\n \"agent_campaigns\": [],\n \"created_by\": 4471,\n \"edited_by\": null\n },\n {\n \"id\": 646,\n \"title\": \"EU customers\",\n \"country\": null,\n \"description\": \"\",\n \"is_global\": false,\n \"create_date\": \"2024-06-04 09:36:39\",\n \"edit_date\": null,\n \"contacts_count\": 0,\n \"agent_campaigns\": [],\n \"created_by\": 4471,\n \"edited_by\": null\n },\n {\n \"id\": 628,\n \"title\": \"Unwanted\",\n \"country\": null,\n \"description\": \"\",\n \"is_global\": false,\n \"create_date\": \"2024-04-27 17:11:35\",\n \"edit_date\": null,\n \"contacts_count\": 280251,\n \"agent_campaigns\": [\n {\n \"id\": 4127,\n \"title\": \"Sales and discounts\",\n \"status\": \"draft\"\n }\n ],\n \"created_by\": 4471,\n \"edited_by\": null\n }\n ],\n \"_meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"fbae542d-0eca-4bc8-a902-bc89011efdef"}],"id":"fa676ee9-d28e-4c23-be65-abbd4cf34dc0","description":"This folder contains actions you may need to manage DNC list contacts.
\nA Do Not Call (DNC) list is a list that filters out customers who do not want to receive unsolicited calls. This feature helps ensure that the customers you contact in your campaigns are more likely to be receptive.
\n","_postman_id":"fa676ee9-d28e-4c23-be65-abbd4cf34dc0"},{"name":"helper","item":[{"name":"getListTimezones","id":"416a0856-5496-4676-980a-757e2d8a7ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n","type":"text"}]},"url":"https://{{host}}/api/v2/helper/getListTimezones?domain={{domain}}","description":"Retrieves a list of timezones.
\n","urlObject":{"protocol":"https","path":["api","v2","helper","getListTimezones"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"d6432538-72c8-4d15-ba34-c2bedce135a0","name":"getListTimezones","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/helper/getListTimezones?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","helper","getListTimezones"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 07:59:11 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"49fd2bbbacb11f499ece2c57a07e8e5f"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"name\": \"Africa/Abidjan\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Accra\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Addis_Ababa\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Algiers\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Asmara\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Bamako\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Bangui\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Banjul\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Bissau\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Blantyre\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Brazzaville\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Bujumbura\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Cairo\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Casablanca\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Ceuta\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Conakry\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Dakar\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Dar_es_Salaam\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Djibouti\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Douala\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/El_Aaiun\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Freetown\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Gaborone\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Harare\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Johannesburg\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Juba\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Kampala\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Khartoum\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Kigali\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Kinshasa\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Lagos\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Libreville\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Lome\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Luanda\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Lubumbashi\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Lusaka\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Malabo\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Maputo\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Maseru\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Mbabane\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Mogadishu\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Monrovia\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Nairobi\",\n \"offset\": 10800\n },\n {\n \"name\": \"Africa/Ndjamena\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Niamey\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Nouakchott\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Ouagadougou\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Porto-Novo\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Sao_Tome\",\n \"offset\": 0\n },\n {\n \"name\": \"Africa/Tripoli\",\n \"offset\": 7200\n },\n {\n \"name\": \"Africa/Tunis\",\n \"offset\": 3600\n },\n {\n \"name\": \"Africa/Windhoek\",\n \"offset\": 7200\n },\n {\n \"name\": \"America/Adak\",\n \"offset\": -32400\n },\n {\n \"name\": \"America/Anchorage\",\n \"offset\": -28800\n },\n {\n \"name\": \"America/Anguilla\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Antigua\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Araguaina\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Buenos_Aires\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Catamarca\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Cordoba\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Jujuy\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/La_Rioja\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Mendoza\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Rio_Gallegos\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Salta\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/San_Juan\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/San_Luis\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Tucuman\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Argentina/Ushuaia\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Aruba\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Asuncion\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Atikokan\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Bahia\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Bahia_Banderas\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Barbados\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Belem\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Belize\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Blanc-Sablon\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Boa_Vista\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Bogota\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Boise\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Cambridge_Bay\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Campo_Grande\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Cancun\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Caracas\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Cayenne\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Cayman\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Chicago\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Chihuahua\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Costa_Rica\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Creston\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Cuiaba\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Curacao\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Danmarkshavn\",\n \"offset\": 0\n },\n {\n \"name\": \"America/Dawson\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Dawson_Creek\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Denver\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Detroit\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Dominica\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Edmonton\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Eirunepe\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/El_Salvador\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Fort_Nelson\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Fortaleza\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Glace_Bay\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Goose_Bay\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Grand_Turk\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Grenada\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Guadeloupe\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Guatemala\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Guayaquil\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Guyana\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Halifax\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Havana\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Hermosillo\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Indiana/Indianapolis\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Indiana/Knox\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Indiana/Marengo\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Indiana/Petersburg\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Indiana/Tell_City\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Indiana/Vevay\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Indiana/Vincennes\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Indiana/Winamac\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Inuvik\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Iqaluit\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Jamaica\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Juneau\",\n \"offset\": -28800\n },\n {\n \"name\": \"America/Kentucky/Louisville\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Kentucky/Monticello\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Kralendijk\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/La_Paz\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Lima\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Los_Angeles\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Lower_Princes\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Maceio\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Managua\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Manaus\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Marigot\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Martinique\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Matamoros\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Mazatlan\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Menominee\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Merida\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Metlakatla\",\n \"offset\": -28800\n },\n {\n \"name\": \"America/Mexico_City\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Miquelon\",\n \"offset\": -7200\n },\n {\n \"name\": \"America/Moncton\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Monterrey\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Montevideo\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Montserrat\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Nassau\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/New_York\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Nipigon\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Nome\",\n \"offset\": -28800\n },\n {\n \"name\": \"America/Noronha\",\n \"offset\": -7200\n },\n {\n \"name\": \"America/North_Dakota/Beulah\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/North_Dakota/Center\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/North_Dakota/New_Salem\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Nuuk\",\n \"offset\": -7200\n },\n {\n \"name\": \"America/Ojinaga\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Panama\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Pangnirtung\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Paramaribo\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Phoenix\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Port-au-Prince\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Port_of_Spain\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Porto_Velho\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Puerto_Rico\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Punta_Arenas\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Rainy_River\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Rankin_Inlet\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Recife\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Regina\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Resolute\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Rio_Branco\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Santarem\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Santiago\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Santo_Domingo\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Sao_Paulo\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Scoresbysund\",\n \"offset\": 0\n },\n {\n \"name\": \"America/Sitka\",\n \"offset\": -28800\n },\n {\n \"name\": \"America/St_Barthelemy\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/St_Johns\",\n \"offset\": -9000\n },\n {\n \"name\": \"America/St_Kitts\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/St_Lucia\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/St_Thomas\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/St_Vincent\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Swift_Current\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Tegucigalpa\",\n \"offset\": -21600\n },\n {\n \"name\": \"America/Thule\",\n \"offset\": -10800\n },\n {\n \"name\": \"America/Thunder_Bay\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Tijuana\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Toronto\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Tortola\",\n \"offset\": -14400\n },\n {\n \"name\": \"America/Vancouver\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Whitehorse\",\n \"offset\": -25200\n },\n {\n \"name\": \"America/Winnipeg\",\n \"offset\": -18000\n },\n {\n \"name\": \"America/Yakutat\",\n \"offset\": -28800\n },\n {\n \"name\": \"America/Yellowknife\",\n \"offset\": -21600\n },\n {\n \"name\": \"Antarctica/Casey\",\n \"offset\": 39600\n },\n {\n \"name\": \"Antarctica/Davis\",\n \"offset\": 25200\n },\n {\n \"name\": \"Antarctica/DumontDUrville\",\n \"offset\": 36000\n },\n {\n \"name\": \"Antarctica/Macquarie\",\n \"offset\": 39600\n },\n {\n \"name\": \"Antarctica/Mawson\",\n \"offset\": 18000\n },\n {\n \"name\": \"Antarctica/McMurdo\",\n \"offset\": 46800\n },\n {\n \"name\": \"Antarctica/Palmer\",\n \"offset\": -10800\n },\n {\n \"name\": \"Antarctica/Rothera\",\n \"offset\": -10800\n },\n {\n \"name\": \"Antarctica/Syowa\",\n \"offset\": 10800\n },\n {\n \"name\": \"Antarctica/Troll\",\n \"offset\": 7200\n },\n {\n \"name\": \"Antarctica/Vostok\",\n \"offset\": 21600\n },\n {\n \"name\": \"Arctic/Longyearbyen\",\n \"offset\": 7200\n },\n {\n \"name\": \"Asia/Aden\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Almaty\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Amman\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Anadyr\",\n \"offset\": 43200\n },\n {\n \"name\": \"Asia/Aqtau\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Aqtobe\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Ashgabat\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Atyrau\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Baghdad\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Bahrain\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Baku\",\n \"offset\": 14400\n },\n {\n \"name\": \"Asia/Bangkok\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Barnaul\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Beirut\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Bishkek\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Brunei\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Chita\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Choibalsan\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Colombo\",\n \"offset\": 19800\n },\n {\n \"name\": \"Asia/Damascus\",\n \"offset\": 7200\n },\n {\n \"name\": \"Asia/Dhaka\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Dili\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Dubai\",\n \"offset\": 14400\n },\n {\n \"name\": \"Asia/Dushanbe\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Famagusta\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Gaza\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Hebron\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Ho_Chi_Minh\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Hong_Kong\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Hovd\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Irkutsk\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Jakarta\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Jayapura\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Jerusalem\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Kabul\",\n \"offset\": 16200\n },\n {\n \"name\": \"Asia/Kamchatka\",\n \"offset\": 43200\n },\n {\n \"name\": \"Asia/Karachi\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Kathmandu\",\n \"offset\": 20700\n },\n {\n \"name\": \"Asia/Khandyga\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Kolkata\",\n \"offset\": 19800\n },\n {\n \"name\": \"Asia/Krasnoyarsk\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Kuala_Lumpur\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Kuching\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Kuwait\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Macau\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Magadan\",\n \"offset\": 39600\n },\n {\n \"name\": \"Asia/Makassar\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Manila\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Muscat\",\n \"offset\": 14400\n },\n {\n \"name\": \"Asia/Nicosia\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Novokuznetsk\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Novosibirsk\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Omsk\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Oral\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Phnom_Penh\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Pontianak\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Pyongyang\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Qatar\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Qostanay\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Qyzylorda\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Riyadh\",\n \"offset\": 10800\n },\n {\n \"name\": \"Asia/Sakhalin\",\n \"offset\": 39600\n },\n {\n \"name\": \"Asia/Samarkand\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Seoul\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Shanghai\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Singapore\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Srednekolymsk\",\n \"offset\": 39600\n },\n {\n \"name\": \"Asia/Taipei\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Tashkent\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Tbilisi\",\n \"offset\": 14400\n },\n {\n \"name\": \"Asia/Tehran\",\n \"offset\": 16200\n },\n {\n \"name\": \"Asia/Thimphu\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Tokyo\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Tomsk\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Ulaanbaatar\",\n \"offset\": 28800\n },\n {\n \"name\": \"Asia/Urumqi\",\n \"offset\": 21600\n },\n {\n \"name\": \"Asia/Ust-Nera\",\n \"offset\": 36000\n },\n {\n \"name\": \"Asia/Vientiane\",\n \"offset\": 25200\n },\n {\n \"name\": \"Asia/Vladivostok\",\n \"offset\": 36000\n },\n {\n \"name\": \"Asia/Yakutsk\",\n \"offset\": 32400\n },\n {\n \"name\": \"Asia/Yangon\",\n \"offset\": 23400\n },\n {\n \"name\": \"Asia/Yekaterinburg\",\n \"offset\": 18000\n },\n {\n \"name\": \"Asia/Yerevan\",\n \"offset\": 14400\n },\n {\n \"name\": \"Atlantic/Azores\",\n \"offset\": 0\n },\n {\n \"name\": \"Atlantic/Bermuda\",\n \"offset\": -10800\n },\n {\n \"name\": \"Atlantic/Canary\",\n \"offset\": 3600\n },\n {\n \"name\": \"Atlantic/Cape_Verde\",\n \"offset\": -3600\n },\n {\n \"name\": \"Atlantic/Faroe\",\n \"offset\": 3600\n },\n {\n \"name\": \"Atlantic/Madeira\",\n \"offset\": 3600\n },\n {\n \"name\": \"Atlantic/Reykjavik\",\n \"offset\": 0\n },\n {\n \"name\": \"Atlantic/South_Georgia\",\n \"offset\": -7200\n },\n {\n \"name\": \"Atlantic/St_Helena\",\n \"offset\": 0\n },\n {\n \"name\": \"Atlantic/Stanley\",\n \"offset\": -10800\n },\n {\n \"name\": \"Australia/Adelaide\",\n \"offset\": 37800\n },\n {\n \"name\": \"Australia/Brisbane\",\n \"offset\": 36000\n },\n {\n \"name\": \"Australia/Broken_Hill\",\n \"offset\": 37800\n },\n {\n \"name\": \"Australia/Darwin\",\n \"offset\": 34200\n },\n {\n \"name\": \"Australia/Eucla\",\n \"offset\": 31500\n },\n {\n \"name\": \"Australia/Hobart\",\n \"offset\": 39600\n },\n {\n \"name\": \"Australia/Lindeman\",\n \"offset\": 36000\n },\n {\n \"name\": \"Australia/Lord_Howe\",\n \"offset\": 39600\n },\n {\n \"name\": \"Australia/Melbourne\",\n \"offset\": 39600\n },\n {\n \"name\": \"Australia/Perth\",\n \"offset\": 28800\n },\n {\n \"name\": \"Australia/Sydney\",\n \"offset\": 39600\n },\n {\n \"name\": \"Europe/Amsterdam\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Andorra\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Astrakhan\",\n \"offset\": 14400\n },\n {\n \"name\": \"Europe/Athens\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Belgrade\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Berlin\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Bratislava\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Brussels\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Bucharest\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Budapest\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Busingen\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Chisinau\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Copenhagen\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Dublin\",\n \"offset\": 3600\n },\n {\n \"name\": \"Europe/Gibraltar\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Guernsey\",\n \"offset\": 3600\n },\n {\n \"name\": \"Europe/Helsinki\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Isle_of_Man\",\n \"offset\": 3600\n },\n {\n \"name\": \"Europe/Istanbul\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Jersey\",\n \"offset\": 3600\n },\n {\n \"name\": \"Europe/Kaliningrad\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Kiev\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Kirov\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Lisbon\",\n \"offset\": 3600\n },\n {\n \"name\": \"Europe/Ljubljana\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/London\",\n \"offset\": 3600\n },\n {\n \"name\": \"Europe/Luxembourg\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Madrid\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Malta\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Mariehamn\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Minsk\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Monaco\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Moscow\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Oslo\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Paris\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Podgorica\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Prague\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Riga\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Rome\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Samara\",\n \"offset\": 14400\n },\n {\n \"name\": \"Europe/San_Marino\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Sarajevo\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Saratov\",\n \"offset\": 14400\n },\n {\n \"name\": \"Europe/Simferopol\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Skopje\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Sofia\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Stockholm\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Tallinn\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Tirane\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Ulyanovsk\",\n \"offset\": 14400\n },\n {\n \"name\": \"Europe/Uzhgorod\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Vaduz\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Vatican\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Vienna\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Vilnius\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Volgograd\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Warsaw\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Zagreb\",\n \"offset\": 7200\n },\n {\n \"name\": \"Europe/Zaporozhye\",\n \"offset\": 10800\n },\n {\n \"name\": \"Europe/Zurich\",\n \"offset\": 7200\n },\n {\n \"name\": \"Indian/Antananarivo\",\n \"offset\": 10800\n },\n {\n \"name\": \"Indian/Chagos\",\n \"offset\": 21600\n },\n {\n \"name\": \"Indian/Christmas\",\n \"offset\": 25200\n },\n {\n \"name\": \"Indian/Cocos\",\n \"offset\": 23400\n },\n {\n \"name\": \"Indian/Comoro\",\n \"offset\": 10800\n },\n {\n \"name\": \"Indian/Kerguelen\",\n \"offset\": 18000\n },\n {\n \"name\": \"Indian/Mahe\",\n \"offset\": 14400\n },\n {\n \"name\": \"Indian/Maldives\",\n \"offset\": 18000\n },\n {\n \"name\": \"Indian/Mauritius\",\n \"offset\": 14400\n },\n {\n \"name\": \"Indian/Mayotte\",\n \"offset\": 10800\n },\n {\n \"name\": \"Indian/Reunion\",\n \"offset\": 14400\n },\n {\n \"name\": \"Pacific/Apia\",\n \"offset\": 46800\n },\n {\n \"name\": \"Pacific/Auckland\",\n \"offset\": 46800\n },\n {\n \"name\": \"Pacific/Bougainville\",\n \"offset\": 39600\n },\n {\n \"name\": \"Pacific/Chatham\",\n \"offset\": 49500\n },\n {\n \"name\": \"Pacific/Chuuk\",\n \"offset\": 36000\n },\n {\n \"name\": \"Pacific/Easter\",\n \"offset\": -18000\n },\n {\n \"name\": \"Pacific/Efate\",\n \"offset\": 39600\n },\n {\n \"name\": \"Pacific/Fakaofo\",\n \"offset\": 46800\n },\n {\n \"name\": \"Pacific/Fiji\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Funafuti\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Galapagos\",\n \"offset\": -21600\n },\n {\n \"name\": \"Pacific/Gambier\",\n \"offset\": -32400\n },\n {\n \"name\": \"Pacific/Guadalcanal\",\n \"offset\": 39600\n },\n {\n \"name\": \"Pacific/Guam\",\n \"offset\": 36000\n },\n {\n \"name\": \"Pacific/Honolulu\",\n \"offset\": -36000\n },\n {\n \"name\": \"Pacific/Kanton\",\n \"offset\": 46800\n },\n {\n \"name\": \"Pacific/Kiritimati\",\n \"offset\": 50400\n },\n {\n \"name\": \"Pacific/Kosrae\",\n \"offset\": 39600\n },\n {\n \"name\": \"Pacific/Kwajalein\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Majuro\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Marquesas\",\n \"offset\": -34200\n },\n {\n \"name\": \"Pacific/Midway\",\n \"offset\": -39600\n },\n {\n \"name\": \"Pacific/Nauru\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Niue\",\n \"offset\": -39600\n },\n {\n \"name\": \"Pacific/Norfolk\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Noumea\",\n \"offset\": 39600\n },\n {\n \"name\": \"Pacific/Pago_Pago\",\n \"offset\": -39600\n },\n {\n \"name\": \"Pacific/Palau\",\n \"offset\": 32400\n },\n {\n \"name\": \"Pacific/Pitcairn\",\n \"offset\": -28800\n },\n {\n \"name\": \"Pacific/Pohnpei\",\n \"offset\": 39600\n },\n {\n \"name\": \"Pacific/Port_Moresby\",\n \"offset\": 36000\n },\n {\n \"name\": \"Pacific/Rarotonga\",\n \"offset\": -36000\n },\n {\n \"name\": \"Pacific/Saipan\",\n \"offset\": 36000\n },\n {\n \"name\": \"Pacific/Tahiti\",\n \"offset\": -36000\n },\n {\n \"name\": \"Pacific/Tarawa\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Tongatapu\",\n \"offset\": 46800\n },\n {\n \"name\": \"Pacific/Wake\",\n \"offset\": 43200\n },\n {\n \"name\": \"Pacific/Wallis\",\n \"offset\": 43200\n },\n {\n \"name\": \"UTC\",\n \"offset\": 0\n }\n ]\n}"}],"_postman_id":"416a0856-5496-4676-980a-757e2d8a7ebb"},{"name":"getTimezonesByNumber","id":"333a4167-537e-4ed6-8c49-bce2e5109bba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"country","value":"","description":"String. Optional.
\nThe phone number country code.
\n","equals":true,"disabled":true},{"key":"phone_number","value":"17472120731","equals":true,"description":"Integer. Required.
\nThe phone number.
\n"}]},"url":"https://{{host}}/api/v2/helper/getTimezonesByNumber?domain={{domain}}","description":"Gets the timezones applied to a specific phone number.
\n","urlObject":{"protocol":"https","path":["api","v2","helper","getTimezonesByNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"e1b02648-941b-4b6b-89f1-ba52d95e8687","name":"getTimezonesByNumber","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"phone_number","value":"17472120731","type":"text"},{"key":"country","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v2/helper/getTimezonesByNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","helper","getTimezonesByNumber"],"query":[{"key":"domain","value":"{{domain}}","description":"required, domain"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 08:16:24 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"9ecd1cda03aca30eb07243057cdb314d"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n \"America/Los_Angeles\"\n ]\n}"}],"_postman_id":"333a4167-537e-4ed6-8c49-bce2e5109bba"}],"id":"26ceef87-0a49-4c3c-bbe1-9de1c9d36501","description":"This folder contains actions you may need to get the information on the account timezones.
\n","_postman_id":"26ceef87-0a49-4c3c-bbe1-9de1c9d36501"},{"name":"history","item":[{"name":"searchCalls","id":"33947111-3b4d-4596-82ea-789248ae08a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"2921787","type":"text","description":"Integer. Optional.
\nThe particular call ID to filter. The maximum is 2147483647 digits, the minimum is 1.
\n"},{"key":"from","value":"2023-05-19 21:00:00","type":"text","description":"String. Optional.
\nThe report start date and time. The pattern is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","disabled":true},{"key":"to","value":"2023-07-17 20:59:59","type":"text","description":"String. Optional.
\nThe report end date and time. The pattern is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","disabled":true},{"key":"with_scenarios","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include scenarios. The options are 1|0|true|false.
\n","disabled":true},{"key":"with_campaigns","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include automated campaigns. The options are 1|0|true|false.
\n","disabled":true},{"key":"with_tags","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include tags. The options are 1|0|true|false.
\n","disabled":true},{"key":"with_wrap_up_code","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include wrap-up codes. The options are 1|0|true|false.
\n","disabled":true},{"key":"with_agent_campaign","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include PDS campaigns. The options are 1|0|true|false.
\n","disabled":true},{"key":"phone","value":"495","description":"String. Optional.
\nThe particular phone number to filter.
\n","type":"text","disabled":true},{"key":"phone_full_text","value":"true","description":"Boolean. Optional.
\nIf set to true, the system searches for a call using an exact phone number match.
\n","type":"text","disabled":true},{"key":"call_direction","value":"all","description":"String. Optional.
\nThe call direction. The options are incoming|outgoing|all.
\n","type":"text","disabled":true},{"key":"scenario_ids","value":"[1]","description":"JSON array. Optional.
\nThe scenario IDs to include in the report. Use the searchScenarios method to retrieve the list of available scenarios. Defaults on [].
\n","type":"text","disabled":true},{"key":"campaign_ids","value":"[1]","description":"JSON array. Optional.
\nThe automated campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].
\n","type":"text","disabled":true},{"key":"tag_ids","value":"[1]","description":"JSON array. Optional.
\nThe tag IDs to include in the report. Use the searchTags method to retrieve the list of available tags. Defaults on [].
\n","type":"text","disabled":true},{"key":"agent_campaign_ids","value":"[1]","description":"JSON array. Optional.
\nThe PDS campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].
\n","type":"text","disabled":true},{"key":"user_ids","value":"[1]","description":"JSON array. Optional.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs. Defaults on [].
\n","type":"text","disabled":true},{"key":"queue_ids","value":"[1]","description":"JSON array. Optional.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues. Defaults on [].
\n","type":"text","disabled":true},{"key":"only_with_scenarios","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should only include scenarios. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"only_with_campaigns","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include automated campaigns. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"only_with_any_campaign","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include automated campaigns. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"only_with_tags","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include tags. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"call_status","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include call statuses. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"only_with_agent_campaigns","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include PDS campaigns. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"only_with_user","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include users. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"only_with_queue","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include queues. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"with_queue","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should include queues. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"with_topics","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should include topics. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"with_transfers","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should include transfers. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"with_comments","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include notes added by agents to conversations.
\n"},{"key":"limit","value":"1","description":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text"},{"key":"cursor","value":"eyJkYXRldGltZV9zdGFydCI6WyI8IiwiMjAyMy0wNS0yMyAxMjo1NjowOCJdLCJpZCI6WyI8IiwyOTIxNzg4XX0=","description":"String. Optional.
\nA cursor to navigate through the report pages (from the first to the last page). If you need to navigate to the first page, the cursor parameter must be empty. The request returns the cursor pointing to the next page. To navigate to the second page, use the returned cursor.
\n","type":"text"},{"key":"wrap_up_code_types","value":"","description":"JSON array. Optional.\nAcceptable values: callback, closure_neutral, closure_negative, closure_success, do_not_call, amd
\n","type":"text","uuid":"3d284eb5-ab09-41f7-87e8-99f8df95e875"},{"key":"attempt_result","value":"","description":"JSON array. Optional.\nAcceptable values: successful, unsuccessful, AMD, answered, disconnected_by_user, disconnected_by_agent, temporary_unavailable, call_busy, no_answer, abandoned, other_reason, call_answered, missed_by_scenario, restricted_by_dnc, lost_by_agent, insufficient_funds, invalid_number, request_terminated, call_was_rejected, other_error, attempt_in_progress, callback_postponed, missed, no_result
\n","type":"text","uuid":"dc8edc83-48a7-4082-bdb0-5ef5322970a3"}]},"url":"https://{{host}}/api/v4/history/searchCalls?domain={{domain}}","description":"Searches for calls with a cursor.
\nUse the completion_code field to determine how the call attempt ended. For possible values, see Completion codes.
\n","urlObject":{"protocol":"https","path":["api","v4","history","searchCalls"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"e3d0ca3b-2735-4a3b-a419-039d56d6f2dd","name":"searchCalls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"2921787","type":"text","description":"Integer. Optional.\n\nThe particular call ID to filter. The maximum is 2147483647 digits, the minimum is 1."},{"key":"from","value":"2022-05-19 21:00:00","type":"text","description":"String. Optional.\n\nThe report's start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","disabled":true},{"key":"to","value":"2022-08-17 20:59:59","type":"text","description":"String. Optional.\n\nThe report's end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","disabled":true},{"key":"with_scenarios","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes scenarios. The options are 1|0|true|false.","disabled":true},{"key":"with_campaigns","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes automated campaigns. The options are 1|0|true|false.","disabled":true},{"key":"with_tags","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes tags. The options are 1|0|true|false.","disabled":true},{"key":"with_wrap_up_code","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes wrap-up codes. The options are 1|0|true|false.","disabled":true},{"key":"with_agent_campaign","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes PDS campaigns. The options are 1|0|true|false.","disabled":true},{"key":"phone","value":"495","description":"String. Optional.\n\nThe particular phone number to filter.","type":"text","disabled":true},{"key":"phone_full_text","value":"true","description":"Boolean. Optional.\n\nIf set to true, the system searches for a call using an exact phone number match.","type":"text","disabled":true},{"key":"call_direction","value":"incoming","description":"String. Optional.\n\nThe call direction. The options are incoming|outgoing|all.","type":"text","disabled":true},{"key":"scenario_ids","value":"[1]","description":"JSON array. Optional.\n\nThe scenario IDs to include in the report. Use the searchScenarios method to retrieve the list of available scenarios. Defaults on [].\n\n","type":"text","disabled":true},{"key":"campaign_ids","value":"[1]","description":"JSON array. Optional.\n\nThe automated campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].\n","type":"text","disabled":true},{"key":"tag_ids","value":"[1]","description":"JSON array. Optional.\n\nThe tag IDs to include in the report. Use the searchTags method to retrieve the list of available tags. Defaults on [].","type":"text","disabled":true},{"key":"agent_campaign_ids","value":"[1]","description":"JSON array. Optional.\n\nThe PDS campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].\n","type":"text","disabled":true},{"key":"user_ids","value":"[1]","description":"JSON array. Optional.\n\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs. Defaults on [].\n","type":"text","disabled":true},{"key":"queue_ids","value":"[1]","description":"JSON array. Optional.\n\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues. Defaults on [].\n","type":"text","disabled":true},{"key":"only_with_scenarios","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report includes only scenarios. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"only_with_campaigns","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only automated campaigns. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"only_with_any_campaign","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only automated campaigns. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"only_with_tags","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only tags. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"call_status","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report includes call statuses. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"only_with_agent_campaigns","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only PDS campaigns. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"only_with_user","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only users. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"only_with_queue","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only queues. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"with_queue","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes queues. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"with_topics","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes topics. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"with_transfers","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes transfers. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"with_comments","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report should include notes added by agents to conversations."},{"key":"limit","value":"20","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","type":"text"},{"key":"cursor","value":"eyJkYXRldGltZV9zdGFydCI6WyI8IiwiMjAyMy0wNS0yMyAxMjo1NjowOCJdLCJpZCI6WyI8IiwyOTIxNzg4XX0=","description":"String. Optional.\n\nA cursor to navigate through the report pages (from the first to the last page). If you need to navigate to the first page, the cursor parameter must be empty. The request returns the cursor pointing to the next page. To navigate to the second page, use the returned cursor.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v4/history/searchCalls?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v4","history","searchCalls"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 11:50:55 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"3c32879883644a40931f913ab52c69ef"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Limit","value":"1"},{"key":"X-Pagination-Cursor","value":"eyJkYXRldGltZV9zdGFydCI6WyI8IiwiMjAyMy0wNS0yMyAxMjo1NTozMyJdLCJpZCI6WyI8IiwyOTIxNzg3XX0="},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 2921787,\n \"attempt_num\": 1,\n \"calllist_item_id\": null,\n \"domain_id\": 169,\n \"session_id\": \"66920373\",\n \"scenario_id\": null,\n \"datetime_start\": \"2023-05-23 12:55:33\",\n \"phone_a\": \"17472120731\",\n \"phone_b\": \"17478092817\",\n \"is_incoming\": false,\n \"call_result_code\": 200,\n \"duration\": 17,\n \"record_url\": null,\n \"call_cost\": \"2.251841\",\n \"call_data\": \"{\\\"UTC\\\": \\\"-8\\\", \\\"name\\\": \\\"ed5\\\", \\\"phone\\\": \\\"17478092817\\\", \\\"next_attempt_interval\\\": null}\",\n \"call_resources\": \"[]\",\n \"call_calls\": \"[{\\\"cost\\\": 0, \\\"call_id\\\": 71460831, \\\"duration\\\": 0, \\\"incoming\\\": false, \\\"start_time\\\": \\\"2023-05-23 12:55:33\\\", \\\"successful\\\": false, \\\"local_number\\\": \\\"\\\", \\\"remote_number\\\": \\\"sip:79778092817@82.202.208.154:9998\\\", \\\"transaction_id\\\": 0, \\\"remote_number_type\\\": \\\"sip\\\"}]\",\n \"call_records\": \"[]\",\n \"call_status\": true,\n \"recalc\": true,\n \"campaign_id\": null,\n \"processing\": false,\n \"scenario_version_id\": null,\n \"has_call_logs\": false,\n \"user_id\": 4629,\n \"dialing_time\": 50,\n \"completion_code\": \"Call_Answered\",\n \"queue_id\": 8416,\n \"user_group_id\": null,\n \"callback_at\": \"2024-12-20 06:15:00\",\n \"comments\": [\n {\n \"id\": 24,\n \"comment\": \"PO number 12345\",\n \"created_by\": 664,\n \"create_date\": \"2023-07-26T13:52:10\",\n \"edit_date\": null\n }\n ]\n }\n ],\n \"_meta\": {\n \"limit\": 1,\n \"cursor\": \"eyJkYXRldGltZV9zdGFydCI6WyI8IiwiMjAyMy0wNS0yMyAxMjo1NTozMyJdLCJpZCI6WyI8IiwyOTIxNzg3XX0=\"\n }\n}"}],"_postman_id":"33947111-3b4d-4596-82ea-789248ae08a4"},{"name":"exportCallsHistoryReport","id":"2e6ca37e-6a15-4d24-895c-679022a75bc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"from","value":"2022-11-14 21:00:00","type":"text","description":"String. Optional.
\nThe report start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","disabled":true},{"key":"to","value":"2022-11-21 20:59:59","type":"text","description":"String. Optional.
\nThe report end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","disabled":true},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"locale","value":"en","description":"String. Optional.
\nThe report language. The available options are ru|en. The default setting is en.
\n","type":"text"},{"key":"call_direction","value":"all","description":"String. Optional.
\nThe call direction. The options are incoming|outgoing|all.
\n","type":"text"},{"key":"only_with_any_campaign","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should only include campaigns (automated and PDS). The options are 1|0|true|false.
\n"},{"key":"campaign_ids","value":"[1]","description":"JSON array. Optional.
\nThe automated campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].
\n","type":"text","disabled":true},{"key":"only_with_campaigns","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should only include automated campaigns. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"call_status","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include call statuses. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"scenario_ids","value":"[1]","description":"JSON array. Optional.
\nThe scenario IDs to include in the report. Use the searchScenarios method to retrieve the list of available scenarios. Defaults on [].
\n","type":"text","disabled":true},{"key":"only_with_scenarios","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should only include scenarios. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"phone","value":"495","description":"String. Optional.
\nThe particular phone number to include in the report.
\n","type":"text","disabled":true},{"key":"only_with_tags","value":"","description":"Boolean. Optional.
\nSpecifies whether the report should only include tags. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"tag_ids","value":"[1]","description":"JSON array. Optional.
\nThe tag IDs to include in the report. Use the searchTags method to retrieve the list of available tags. Defaults on [].
\n","type":"text","disabled":true},{"key":"only_with_user","value":"[1]","description":"Boolean. Optional.
\nSpecifies whether the report should only include users. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"user_ids","value":"[2]","description":"JSON array. Optional.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs. Defaults on [].
\n","type":"text","disabled":true},{"key":"user_group_ids","value":"[176,177,178]","description":"JSON array. Optional.
\nThe group IDs to include in the report. Use the searchGroups method to retrieve the list of available groups.
\n","type":"text","disabled":true},{"key":"only_with_queue","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include queues. The options are 1|0|true|false.
\n","type":"text","disabled":true},{"key":"queue_ids","value":"[6,1]","description":"JSON array. Optional.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues. Defaults on [].
\n","type":"text","disabled":true},{"key":"agent_campaign_ids","value":"[]","description":"JSON array. Optional.
\nThe PDS campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].
\n","type":"text","disabled":true},{"key":"only_with_agent_campaigns","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should only include PDS campaigns. The options are 1|0|true|false.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/history/exportCallsHistoryReport?domain={{domain}}","description":"Generates a call history report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","history","exportCallsHistoryReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"48bfa193-99ad-4b0f-9c37-cb8e6a45a188","name":"exportCallsHistoryReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"from","value":"2022-11-14 21:00:00","type":"text","description":"String. Optional.\n\nThe report's start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","disabled":true},{"key":"to","value":"2022-11-21 20:59:59","type":"text","description":"String. Optional.\n\nThe report's end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","disabled":true},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.\n\nThe report format. The supported formats are xlsx and csv, the default option is xlsx."},{"key":"locale","value":"en","description":"String. Optional.\n\nThe report language. The available options are ru|en. The default setting is en. ","type":"text"},{"key":"call_direction","value":"all","description":"String. Optional.\n\nThe call direction. The options are incoming|outgoing|all.","type":"text"},{"key":"only_with_any_campaign","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the report includes only campaigns (automated and PDS. The options are 1|0|true|false."},{"key":"campaign_ids","value":"[1]","description":"JSON array. Optional.\n\nThe automated campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].\n","type":"text","disabled":true},{"key":"only_with_campaigns","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report includes only automated campaigns. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"call_status","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report includes call statuses. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"scenario_ids","value":"[1]","description":"JSON array. Optional.\n\nThe scenario IDs to include in the report. Use the searchScenarios method to retrieve the list of available scenarios. Defaults on [].\n","type":"text","disabled":true},{"key":"only_with_scenarios","value":"true","description":"Boolean. Optional.\n\nSpecifies whether the report includes only scenarios. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"phone","value":"495","description":"String. Optional.\n\nThe particular phone number to include in the report.","type":"text","disabled":true},{"key":"only_with_tags","value":"","description":"Boolean. Optional.\n\nSpecifies whether the report includes only tags. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"tag_ids","value":"[1]","description":"JSON array. Optional.\n\nThe tag IDs to include in the report. Use the searchTags method to retrieve the list of available tags. Defaults on [].","type":"text","disabled":true},{"key":"only_with_user","value":"[1]","description":"Boolean. Optional.\n\nSpecifies whether the report includes only users. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"user_ids","value":"[2]","description":"JSON array. Optional.\n\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs. Defaults on [].\n","type":"text","disabled":true},{"key":"user_group_ids","value":"[176,177,178]","description":"JSON array. Optional.\n\nThe group IDs to include in the report. Use the searchGroups method to retrieve the list of available groups.","type":"text","disabled":true},{"key":"only_with_queue","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only queues. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"queue_ids","value":"[6,1]","description":"JSON array. Optional.\n\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues. Defaults on [].\n\n","type":"text","disabled":true},{"key":"agent_campaign_ids","value":"[]","description":"JSON array. Optional.\n\nThe PDS campaign IDs to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. Defaults on [].\n","type":"text","disabled":true},{"key":"only_with_agent_campaigns","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only PDS campaigns. The options are 1|0|true|false.","type":"text","disabled":true},{"key":"dialer_campaign_ids","value":"[]","description":"JSON array. Optional.\n\nList of dialer campaigns ids. Defaults on [].","type":"text","uuid":"b35f871b-d255-4e90-8c42-6afacab22bfe","disabled":true},{"key":"only_with_dialer_campaigns","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report includes only dialer campaigns. The options are 1|0|true|false.","type":"text","uuid":"9170a913-fe76-457c-bf38-ef7e771e2468","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/history/exportCallsHistoryReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","history","exportCallsHistoryReport"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 12:13:05 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"da0100710c660494edef57ac92e9ce58"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"1"},{"key":"X-Rate-Limit-Remaining","value":"0"},{"key":"X-Rate-Limit-Reset","value":"1"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 5114\n }\n}"}],"_postman_id":"2e6ca37e-6a15-4d24-895c-679022a75bc9"},{"name":"searchStatuses","id":"74f7eab5-db7f-4159-b893-1ac08112a26d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"from","value":"2022-11-14 21:00:00","type":"text","description":"String. Optional.
\nThe report start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00. Defaults on 2 weeks before 00:00:00.
\n","disabled":true},{"key":"to","value":"2022-11-15 21:00:00","type":"text","description":"String. Optional.
\nThe report end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00. Defaults on the current date and time.
\n","disabled":true},{"key":"user_ids","value":"[1774]","type":"text","description":"JSON array. Optional.
\nThe particular user IDs to filter. Use the searchUsers method to retrieve the list of user IDs.
\n","disabled":true},{"key":"statuses","value":"[\"ONLINE\", \"READY\"]","type":"text","description":"JSON array. Optional.
\nThe particular statuses to filter.
\nThe options are: ONLINE|OFFLINE|READY|IN_SERVICE|AFTER_SERVICE|DND|BANNED|DIALING|DND|CUSTOM_1|CUSTOM_2|CUSTOM_3|CUSTOM_4|CUSTOM_5|CUSTOM_6|CUSTOM_7|CUSTOM_8|CUSTOM_9|CUSTOM_10.
\n","disabled":true},{"key":"group_ids","value":"[1,712]","description":"JSON array. Optional.
\nThe particular user group IDs to filter. Use the searchGroups method to retrieve the list of user group IDs.
\n","type":"text","disabled":true},{"key":"timezone","value":"Europe/Lisbon","description":"String. Optional.
\nThe timezone used in the date_from and date_to parameters. By default, the system uses the timezone specified in the Profile settings.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/history/searchStatuses?domain={{domain}}","description":"Retrieves user status transition history.
\n","urlObject":{"protocol":"https","path":["api","v3","history","searchStatuses"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"20"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting. The options are id|user_id|status|status_start_date|status_end_date|next_status|duration.
\n","type":"text/plain"},"key":"sort","value":"-duration"}],"variable":[]}},"response":[{"id":"deec3588-a5f4-4e89-8b24-a82db410a9c4","name":"searchStatuses","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"from","value":"2022-11-14 21:00:00","type":"text","description":"String. Optional.\n\nThe report's start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00. Defaults on 2 weeks before 00:00:00.","disabled":true},{"key":"to","value":"2022-11-15 21:00:00","type":"text","description":"String. Optional.\n\nThe report's end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00. defaults on the current date and time.","disabled":true},{"key":"user_ids","value":"[1774]","type":"text","description":"JSON array. Optional.\n\nThe particular user IDs to filter. Use the searchUsers method to retrieve the list of user IDs.","disabled":true},{"key":"statuses","value":"[\"ONLINE\", \"READY\"]","type":"text","description":"JSON array. Optional. \n\nThe particular statuses to filter.\n\nThe options are: ONLINE|OFFLINE|READY|IN_SERVICE|AFTER_SERVICE|DND|BANNED|DIALING|DND|CUSTOM_1|CUSTOM_2|CUSTOM_3|CUSTOM_4|CUSTOM_5|CUSTOM_6|CUSTOM_7|CUSTOM_8|CUSTOM_9|CUSTOM_10","disabled":true},{"key":"group_ids","value":"[1,712]","description":"JSON array. Optional.\n\nThe particular user group IDs to filter. Use the searchGroups method to retrieve the list of user IDs.","type":"text","disabled":true},{"key":"sort","value":"-duration","description":"String. Optional.\n\nThe sorting criteria. The options are id|user_id|status|status_start_date|status_end_date|next_status|duration.","type":"text","disabled":true},{"key":"timezone","value":"Europe/Lisbon","description":"String. Optional.\n\nThe timezone used in the date_from and date_to parameters. By default, the system uses the timezone specified in the Profile settings.","type":"text","disabled":true},{"key":"page","value":"2","type":"text","description":"Integer. Optional.\n\nThe report page number.","disabled":true},{"key":"per-page","value":"20","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/history/searchStatuses?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","history","searchStatuses"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 12:00:29 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"a366cbdaf334dcd763353c964f37a780"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"X-Pagination-Total-Count","value":"52"},{"key":"X-Pagination-Page-Count","value":"3"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"from","value":"2022-12-09 21:00:00","type":"text","description":"String. Optional.
\nThe report start date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00. Defaults on 2 weeks before 00:00:00.
\n","disabled":true},{"key":"to","value":"2022-12-17 20:59:59","type":"text","description":"String. Optional.
\nThe report end date and time. The pattern YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00. defaults on the current date and time.
\n","disabled":true},{"key":"locale","value":"en","description":"String. Optional.
\nThe report language. The available options are ru|en. The default setting is en.
\n","type":"text","disabled":true},{"key":"timezone","value":"Europe/Lisbon","description":"String. Optional.
\nThe timezone used in the date_from and date_to parameters. By default, the system uses the timezone specified in the Profile settings.
\n","type":"text","disabled":true},{"key":"format","value":"csv","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n","type":"text","disabled":true},{"key":"statuses","value":"[\"ONLINE\"]","description":"JSON array. Optional.
\nThe statuses to include in the report.
\nThe options are: ONLINE|OFFLINE|READY|IN_SERVICE|AFTER_SERVICE|DND|BANNED|DIALING|DND|CUSTOM_1|CUSTOM_2|CUSTOM_3|CUSTOM_4|CUSTOM_5|CUSTOM_6|CUSTOM_7|CUSTOM_8|CUSTOM_9|CUSTOM_10.
\n","type":"text","disabled":true},{"key":"group_ids","value":"[510]","description":"JSON array. Optional.
\nThe user group IDs to include in the report. Use the searchGroups method to retrieve the list of user group IDs.
\n","type":"text","disabled":true},{"key":"user_ids","value":"[1693]","description":"JSON array. Optional.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/history/exportStatusHistoryReport?domain={{domain}}","description":"Generates a user status transition history report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","history","exportStatusHistoryReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"71e933c7-5d27-403f-8634-8223acf2ba4a","name":"exportStatusHistoryReport","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true},{"key":"from","value":"2022-12-09 21:00:00","type":"text","description":"optional, datetime “YYYY-mm-dd Hi:s“, default = 2 weeks ago 00:00:00","disabled":true},{"key":"to","value":"2022-12-17 20:59:59","type":"text","description":"optional, datetime “YYYY-mm-dd Hi:s“, default = now","disabled":true},{"key":"locale","value":"en","description":"optional, string ru|en, default = en","type":"text","disabled":true},{"key":"timezone","value":"Asia/Yekaterinburg","description":"optional, string, default: user timezone from profile settings\nТаймзона в которых указаны date_from и date_to.\nПоумолчанию используется таймзона пользователя из настроек в лк кита","type":"text","disabled":true},{"key":"format","value":"csv","description":"optional, string csv|xlsx, default = xlsx","type":"text","disabled":true},{"key":"statuses","value":"[\"ONLINE\"]","description":"optional, json array [string, string, ...], allowed values: ONLINE|OFFLINE|READY|IN_SERVICE|AFTER_SERVICE|DND|BANNED|DIALING|DND|CUSTOM_1|CUSTOM_2|CUSTOM_3|CUSTOM_4|CUSTOM_5|CUSTOM_6|CUSTOM_7|CUSTOM_8|CUSTOM_9|CUSTOM_10","type":"text","disabled":true},{"key":"group_ids","value":"[510]","description":"optional, json array [int, int, …]","type":"text","disabled":true},{"key":"user_ids","value":"[1693]","description":"optional, json array [int, int, …]","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/history/exportStatusHistoryReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","history","exportStatusHistoryReport"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 12:01:08 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"1a2a82ab8e6d2e090a18ee5adb1c6591"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"1"},{"key":"X-Rate-Limit-Remaining","value":"0"},{"key":"X-Rate-Limit-Reset","value":"1"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 5113\n }\n}"}],"_postman_id":"e3bf19b4-f5bb-4f0c-8db5-75528b97f1ef"}],"id":"8b001f51-bebe-4d1e-af36-9821874f826e","description":"The folder contains actions you may need to search for calls and get call and status reports.
\n","_postman_id":"8b001f51-bebe-4d1e-af36-9821874f826e"},{"name":"ip","item":[{"name":"searchWhitelist","id":"ed49e8f8-18b8-4eca-bc93-a8a24e6f2367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"","description":"Integer. Optional.
\nThe particular whitelisted IP address ID to filter.
\n","type":"text","disabled":true},{"key":"ip","value":"","description":"String. Optional.
\nThe particular whitelisted IP address to filter.
\nNOTE: The request also returns partial matches.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/ip/searchWhitelist?domain={{domain}}","description":"Retrieves a list of IP addresses added to the account API whitelist.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","ip","searchWhitelist"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c2b740be-8c52-4508-96a2-c58cf06e750e","name":"searchWhitelist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"","type":"text","disabled":true},{"key":"ip","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/ip/searchWhitelist?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","ip","searchWhitelist"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 09:47:45 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"eccf2bb252fae8a7914dc5932525331c"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"This folder contains actions you may need to manage the API whitelist.
\nThe API whitelisting feature lets you create a list of trusted IP addresses that can access Voximplant Kit and make API requests. Once you add IP addresses to the whitelist, users can log in to Voximplant Kit and make API requests from these addresses only. The system automatically disables logins from IPs that are out of the whitelist. API requests from suspect non-whitelisted IPs are not allowed.
\n","_postman_id":"9afc75a4-c50d-4282-9db8-45eeb5853d1c"},{"name":"media","item":[{"name":"searchMedia","id":"bedfa816-7723-49b3-9fe8-ec0cc0f7e54f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"folder_id","value":"","type":"text","description":"Integer. Optional.
\nThe particular storage folder ID to filter.
\n","disabled":true},{"key":"id","value":"","type":"text","description":"Integer. Optional.
\nThe particular media file ID to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/media/searchMedia?domain={{domain}}","description":"Retrieves a list of all media files on the account.
\nIf you define specific query parameters, the request returns only the files that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","media","searchMedia"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"703a208a-fbe0-4f75-a78a-ef51be002b0b","name":"searchMedia","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"folder_id","value":"23","type":"text","disabled":true},{"key":"id","value":"301","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/media/searchMedia?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","media","searchMedia"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 09:03:53 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4abaea17077c5dfc063a9f300565b90f"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"file","type":"file","description":"File. Required.
\nYou can upload the following MIME types: audio/mp3, audio/mpeg, application/octet-stream.
\nFor more information on how to upload files in Postman, go here: https://learning.postman.com/docs/getting-started/settings/#general.
\n","src":"3pXOc-n0s/audio.mp3"}]},"url":"https://{{host}}/api/v3/media/uploadMedia?domain={{domain}}","description":"Uploads a media file to the account.
\n","urlObject":{"protocol":"https","path":["api","v3","media","uploadMedia"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"a8e236b0-aa97-4d24-beac-8fbef40be8ba","name":"uploadMedia","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your API token."},{"key":"file","type":"file","description":"Required. File.","src":"o17XRPYqh/sample-3s.mp3"}]},"url":{"raw":"https://{{host}}/api/v3/media/uploadMedia?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","media","uploadMedia"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 09:40:54 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"472475dd5df5e7b22caaa3e6ac148cbc"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 1345,\n \"title\": \"sample-3s\",\n \"domain_id\": 169,\n \"file_id\": 24899,\n \"folder_id\": null\n }\n}"}],"_postman_id":"7f818695-f7c7-4fd0-bf66-b81f8767d9e3"},{"name":"deleteMedia","id":"6c3dcc15-43a2-46ee-9f06-22526d705917","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1345","type":"text","description":"Integer. Required.
\nThe media file ID. Use the searchMedia method to retrieve the list of available media files.
\n"}]},"url":"https://{{host}}/api/v3/media/deleteMedia?domain={{domain}}","description":"Deletes a media file from the account.
\n","urlObject":{"protocol":"https","path":["api","v3","media","deleteMedia"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"b103b894-c306-4e32-b55f-c82c05fa5971","name":"deleteMedia","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"1345","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/media/deleteMedia?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","media","deleteMedia"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 09:44:46 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4b19b4926c576d7b407eba0572d135b5"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"6c3dcc15-43a2-46ee-9f06-22526d705917"}],"id":"b068aa5a-3d00-47a9-a0fe-cc8ecc2f4115","description":"This folder contains actions you may need to manage media files.
\n","_postman_id":"b068aa5a-3d00-47a9-a0fe-cc8ecc2f4115"},{"name":"messaging","item":[{"name":"getConversationHistory","id":"b385d8bf-d992-47d0-a437-b366a740fe87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n","type":"text"},{"key":"incoming_request_id","value":"20","description":"Integer. Required.
\nThe particular chat session ID to filter. Use the getListIncomingRequests method to retrieve the list of available chat session IDs.
\n","type":"text"},{"key":"from","value":"2025-02-05 15:04:05","description":"String. Optional.
\nThe start date and time for data retrieval. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","type":"text","disabled":true},{"key":"to","value":"2025-02-07 15:04:05","description":"String. Optional.
\nThe end date and time for data retrieval. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","type":"text","disabled":true},{"key":"with_attach_info","value":"false","description":"Boolean. Optional.
\nSpecifies whether the response should contain information on the conversation attachments. The default value is false.
\n","type":"text","disabled":true},{"key":"with_bot_msg","value":"false","description":"Boolean. Optional.
\nSpecifies whether the request response should include bot conversations. The default value is false.
\n","type":"text","disabled":true},{"key":"cursor","value":"","description":"String. Optional.
\nA cursor to navigate through the report pages (from the first to the last page). If you need to navigate to the first page, the cursor parameter must be empty. The request returns the cursor pointing to the next page. To navigate to the second page, use the returned cursor.
\n","type":"text","disabled":true},{"key":"limit","value":"2","description":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v4/messaging/getConversationHistory?domain={{domain}}","description":"Gets the history of a particular chat session by its ID. The history includes all messages within the session.
\n","urlObject":{"protocol":"https","path":["api","v4","messaging","getConversationHistory"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"21a730c3-f71a-4a8e-aa4a-bae6f4ddd585","name":"getConversationHistory","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token.","type":"text"},{"key":"incoming_request_id","value":"20","description":"Integer. Required.\n\nThe particular conversation ID to filter. Use the getListIncomingRequests method to retreive the list of available conversation IDs.","type":"text"},{"key":"from","value":"2025-02-05 15:04:05","description":"String. Optional.\n\nThe start date and time of the period to analyze conversation history. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","type":"text","disabled":true},{"key":"to","value":"2025-02-07 15:04:05","description":"String. Optional.\n\nThe end date and time of the period to analyze conversation history. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","type":"text","disabled":true},{"key":"with_attach_info","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the conversation has attachments. The default value is false.","type":"text","disabled":true},{"key":"with_bot_msg","value":"false","description":"Boolean. Optional.\n\nSpecifies whether request response should include bot conversations. The default value is false.","type":"text","disabled":true},{"key":"cursor","value":"","description":"String. Optional.\n\nA cursor to navigate through the report pages (from the first to the last page). If you need to navigate to the first page, the cursor parameter must be empty. The request returns the cursor pointing to the next page. To navigate to the second page, use the returned cursor.","type":"text","disabled":true},{"key":"limit","value":"2","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v4/messaging/getConversationHistory?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v4","messaging","getConversationHistory"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": {\r\n \"conversation_uuid\": \"52781056-e6de-4310-8575-bf46cff4ad12\",\r\n \"incoming_request_id\": 20,\r\n \"messages\": [\r\n {\r\n \"message_id\": 432,\r\n \"create_date\": \"2025-04-21 07:32:35\",\r\n \"sender\": \"agent\",\r\n \"message_text\": \"Thank you\",\r\n \"attachment_count\": 0,\r\n \"attachments\": [],\r\n \"user_id\": 111\r\n },\r\n {\r\n \"message_id\": 429,\r\n \"create_date\": \"2025-04-21 07:31:54\",\r\n \"sender\": \"agent\",\r\n \"message_text\": \"Good bye\",\r\n \"attachment_count\": 2,\r\n \"attachments\": [\r\n {\r\n \"message_type\": \"text\",\r\n \"sender_type\": \"agent\",\r\n \"title\": \"Email\",\r\n \"type\": \"video\",\r\n \"uuid\": \"1829216f-a0fd-4d00-8ec4-14314d95eec9\"\r\n },\r\n {\r\n \"content_type\": \"image/jpeg\",\r\n \"file_id\": 4,\r\n \"file_name\": \"000029_1534775257_314671_big.jpg\",\r\n \"file_size\": 48862,\r\n \"type\": \"photo\",\r\n \"url\": \"https://smartcalls.localhost/api/v3/messaging/getStreamFile?id=4&token=2rZ8J7wvOP7zGig1y2fhG9YgfcF\"\r\n }\r\n ],\r\n \"user_id\": 222\r\n }\r\n ]\r\n },\r\n \"_meta\": {\r\n \"cursor\": \"W1siY3JlYXRlX2RhdGUiLDAsIjIwMjUtMDQtMjEgMDc6MzE6NTQiXSxbImlkIiwwLDQyOV1d\",\r\n \"limit\": 2\r\n }\r\n}"}],"_postman_id":"b385d8bf-d992-47d0-a437-b366a740fe87"},{"name":"getListIncomingRequests","id":"df894915-293b-4c26-a10c-7740cdc0c26b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"12345","type":"text","description":"String. Optional.
\nThe particular chat session ID to filter.
\n","disabled":true},{"key":"conversation_uuid","value":"a57c845f-ea02-43e9-b7b9-224a27faf77a","type":"text","description":"String. Optional.
\nThe particular chat UUID to filter. You can copy it in your Workspace or in the History > Messaging section.
\n","disabled":true},{"key":"from","value":"2025-02-02 00:00:00","type":"text","description":"String. Optional.
\nThe start date and time for data retrieval. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","disabled":true},{"key":"to","value":"2025-02-05 00:00:00","type":"text","description":"String. Optional.
\nThe end date and time for data retrieval. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n","disabled":true},{"key":"customer_filter","value":"John","type":"text","description":"String. Optional.
\nCustomer information (name, email, phone number) to filter.
\n","disabled":true},{"key":"completed","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether the chat session is completed.
\nIf set to \"true\", the response returns only session IDs within your chats that are closed.
\nIf set to \"false\", the response returns only session IDs within your chats that are still open.
\nIf you do not pass this parameter, the system returns both open and closed chat sessions by default.
\n","disabled":true},{"key":"user_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.
\nThe particular IDs of the users who processed chat sessions to filter. Use the searchUsers method to retrieve the list of available user IDs.
\n","disabled":true},{"key":"queue_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.
\nThe particular queue IDs to filter. Use the searchQueues method to retrieve the list of available queue IDs.
\n","disabled":true},{"key":"channel_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.
\nThe particular channel IDs to filter. You can copy a channel ID in the address bar of the Edit channel screen.
\n","disabled":true},{"key":"tag_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.
\nThe particular tag IDs to filter. Use the searchTags method to retrieve the list of available tag IDs.
\n","disabled":true},{"key":"topic_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.
\nThe particular topic IDs to filter. Use the searchTopics method to retrieve the list of available topic IDs.
\n","disabled":true},{"key":"with_queue","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the response should contain queue information.
\n","disabled":true},{"key":"with_channel","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the response should contain channel information.
\n","disabled":true},{"key":"with_tags","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the response should contain tags.
\n","disabled":true},{"key":"with_topics","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the response should contain topics.
\n","disabled":true},{"key":"cursor","value":"","type":"text","description":"String. Optional.
\nA cursor to navigate through the report pages (from the first to the last page). If you need to navigate to the first page, the cursor parameter must be empty. The request returns the cursor pointing to the next page. To navigate to the second page, use the returned cursor.
\n","disabled":true},{"key":"limit","value":"20","description":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","uuid":"1e134ac4-1051-4d50-afef-eac8a366f983","disabled":true}]},"url":"https://{{host}}/api/v4/messaging/getListIncomingRequests?domain={{domain}}","description":"Retrieves the list of chat session IDs.
\nIf you define specific query parameters, the request retrieves only the session IDs that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v4","messaging","getListIncomingRequests"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting. Default: -start_time.
\n","type":"text/plain"},"key":"sort","value":"-start_time"}],"variable":[]}},"response":[{"id":"e1edeb74-1c0f-4460-b113-be098ba26fda","name":"getListIncomingRequests","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"12345","type":"text","description":"String. Optional.\n\nThe particular chat session ID to filter.","disabled":true},{"key":"conversation_uuid","value":"a57c845f-ea02-43e9-b7b9-224a27faf77a","type":"text","description":"String. Optional.\n\nThe particular conversation ID to filter.","disabled":true},{"key":"from","value":"2025-02-02 00:00:00","type":"text","description":"String. Optional.\n\nThe start date and time for data retrieval. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","disabled":true},{"key":"to","value":"2025-02-05 00:00:00","type":"text","description":"String. Optional.\n\nThe end date and time for data retrieval. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.","disabled":true},{"key":"customer_filter","value":"John","type":"text","description":"String. Boolean.\n\nCustomer information (name, email, phone number) to filter.","disabled":true},{"key":"completed","value":"false","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the chat session is completed. The default value is true.\n\nIf set to \"true\", the response returns only session IDs within your chats that are closed.\n\nIf set to \"false\", the response returns only session IDs within your chats that are still open. ","disabled":true},{"key":"user_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.\n\nThe particular IDs of the users who processed chat sessions to filter.","disabled":true},{"key":"queue_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.\n\nThe particular queue IDs to filter.","disabled":true},{"key":"channel_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.\n\nThe particular channel IDs to filter.","disabled":true},{"key":"tag_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.\n\nThe particular tag IDs to filter.","disabled":true},{"key":"topic_ids","value":"[1, 2, 3]","type":"text","description":"Integer array. Optional.\n\nThe particular topic IDs to filter.","disabled":true},{"key":"with_queue","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the response should contain queue information.","disabled":true},{"key":"with_channel","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the response should contain channel information.","disabled":true},{"key":"with_tags","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the response should contain tags.","disabled":true},{"key":"with_topics","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the response should contain topics.","disabled":true},{"key":"cursor","value":"","type":"text","description":"String. Optional.\n\nA cursor to navigate through the report pages (from the first to the last page). If you need to navigate to the first page, the cursor parameter must be empty. The request returns the cursor pointing to the next page. To navigate to the second page, use the returned cursor.","disabled":true},{"key":"limit","value":"20","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","uuid":"1e134ac4-1051-4d50-afef-eac8a366f983","disabled":true}]},"url":{"raw":"https://{{host}}/api/v4/messaging/getListIncomingRequests?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v4","messaging","getListIncomingRequests"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"sort","value":"-start_time","description":"optional, default: -start_time, options: start_time","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": [\r\n {\r\n \"id\": 55,\r\n \"conversation_id\": 4,\r\n \"conversation_uuid\": \"a57c845f-ea02-43e9-b7b9-224a27faf77d\",\r\n \"conversation_status\": \"done\",\r\n \"is_incoming\": false,\r\n \"completed\": true,\r\n \"was_lost\": false,\r\n \"is_client_replied\": false,\r\n \"start_time\": \"2025-04-27T13:31:29Z\",\r\n \"handling_start_time\": \"2025-04-27T13:31:29Z\",\r\n \"end_time\": \"2025-04-28T16:08:21Z\",\r\n \"first_response_time\": \"2025-04-28T16:08:21Z\",\r\n \"lost_time\": \"2025-04-28T16:00:19Z\",\r\n \"user_id\": 123123,\r\n \"closed_by\": 123,\r\n \"request_variables\": {\r\n \"current_date\": \"28.03.2025\",\r\n \"name\": \"Important\"\r\n },\r\n \"customer\": {\r\n \"display_name\": \"John Smith\",\r\n \"phones\": [\r\n \"142005553535\"\r\n ],\r\n \"emails\": [\r\n \"jsmith@example.com\",\r\n \"jsmith@example.com\"\r\n ]\r\n },\r\n \"queue\": {\r\n \"id\": 1,\r\n \"name\": \"VIP customers\",\r\n \"title\": \"Queue 1\"\r\n },\r\n \"channel\": {\r\n \"id\": 15,\r\n \"uuid\": \"f9191d51-22be-4ce0-b311-2a97d2a5f08e\",\r\n \"type\": \"Whatsapp\",\r\n \"description\": \"For exteral POs\"\r\n },\r\n \"tags\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"VIP\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"name\": \"Hign importance\"\r\n }\r\n ],\r\n \"topics\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"Far East\"\r\n }\r\n ]\r\n },\r\n {\r\n \"id\": 56,\r\n \"conversation_id\": 4,\r\n \"conversation_uuid\": \"a57c845f-ea02-43e9-b7b9-224a27faf77d\",\r\n \"conversation_status\": \"new\",\r\n \"is_incoming\": true,\r\n \"completed\": false,\r\n \"was_lost\": false,\r\n \"is_client_replied\": false,\r\n \"start_time\": null,\r\n \"handling_start_time\": null,\r\n \"end_time\": null,\r\n \"first_response_time\": null,\r\n \"lost_time\": null,\r\n \"user_id\": 123123,\r\n \"closed_by\": null,\r\n \"request_variables\": null,\r\n \"customer\": {\r\n \"display_name\": \"\",\r\n \"phones\": null,\r\n \"emails\": null\r\n },\r\n \"queue\": null,\r\n \"channel\": null,\r\n \"tags\": null,\r\n \"topics\": null\r\n }\r\n ],\r\n \"_meta\": {\r\n \"cursor\": \"W1sic3RhcnRfdGltZSIsMCwiMjAyNS0wMy0yOCAxMjoyOTozMyJdLFsiaWQiLDAsNzEzMzIxXV0=\",\r\n \"limit\": 20\r\n }\r\n}"}],"_postman_id":"df894915-293b-4c26-a10c-7740cdc0c26b"}],"id":"9ff2517e-bec8-47ad-bc35-3892c129076a","description":"This folder contains actions you may need to get conversation history and chat session IDs.
\n","_postman_id":"9ff2517e-bec8-47ad-bc35-3892c129076a"},{"name":"outbound","item":[{"name":"appendToCampaign","id":"103cdef5-ec92-4a52-803a-416339fc0ef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"campaign_id","value":"829","type":"text","description":"Integer. Required.
\nThe automated campaign ID. Use the searchCampaigns method to retrieve the list of available automated campaigns.
\n"},{"key":"rows","value":"[{\"phone\":\"19778092817\",\"UTC\":\"3\"}]","type":"text","description":"JSON array. Required.
\nThe rows you want to add to the campaign contact list. Maximum is 5000. The phone and UTC fields are required. Example: [{\"phone\":\"17478092817\",\"UTC\":\"3\"}]
\nIMPORTANT! The \"rows\" parameter must contain the same set of fields (phone, UTC, etc.) in one API request.
\nCorrect: [{\"phone\":\"17474888510\",\"UTC\":\"America/Aruba\", \"client_id\":\"12345\"}, {\"phone\":\"17474880000\",\"UTC\":\"America/NY\", \"client_id\":\"54321\"}]
\nIncorrect: [{\"phone\":\"17474888510\",\"UTC\":\"America/Aruba\"}, {\"phone\":\"17474880000\",\"UTC\":\"America/NY\", \"client_id\":\"54321\"}]
\n"},{"key":"force","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the system should make a second attempt to add contacts if the first attempt failed due to network problems. The default setting is false.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/outbound/appendToCampaign?domain={{domain}}","description":"Adds contacts to a campaign contact list.
\n","urlObject":{"protocol":"https","path":["api","v3","outbound","appendToCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"6d00d470-d012-4da3-a747-99eddbfb1abd","name":"appendToCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"campaign_id","value":"829","type":"text"},{"key":"rows","value":"[{\"phone\":\"19778092817\",\"UTC\":\"3\"}]","type":"text"},{"key":"force","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/outbound/appendToCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","outbound","appendToCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 13:08:40 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"38e85435b81a36b79d7e7d50f47b1839"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"result\": true,\n \"is_appended\": true,\n \"list_id\": 2962,\n \"call_list_id\": 2962,\n \"count\": 1,\n \"success_count\": 1,\n \"errors_count\": 0,\n \"fail_list\": []\n }\n}"}],"_postman_id":"103cdef5-ec92-4a52-803a-416339fc0ef1"},{"name":"deleteCampaign","id":"749eacc0-3665-422e-b730-229c44bba6a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"6154","type":"text","description":"Integer. Required.
\nThe automated campaign ID. Use the searchCampaigns method to retrieve the list of available automated campaigns. The minimum length is 1 digit.
\n"}]},"url":"https://{{host}}/api/v2/outbound/deleteCampaign?domain={{domain}}","description":"Deletes an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v2","outbound","deleteCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"4f20e67a-eadf-49ea-8094-968231c29c9c","name":"deleteCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"6","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/outbound/deleteCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","outbound","deleteCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 13:38:34 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"fdc9ec91fd11c1527aa69fb87bedd923"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"749eacc0-3665-422e-b730-229c44bba6a6"},{"name":"pauseCampaign","id":"299a2d53-f087-40a7-a471-c209dfd40dc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1622","type":"text","description":"Integer. Required.
\nThe automated campaign ID. Use the searchCampaigns method to retrieve the list of available automated campaigns. The minimum length is 1 digit.
\n"}]},"url":"https://{{host}}/api/v3/outbound/pauseCampaign?domain={{domain}}","description":"Suspends an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v3","outbound","pauseCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"7e07cde5-4d98-4d18-b27e-f71759f71118","name":"pauseCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"1215","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/outbound/pauseCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","outbound","pauseCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 18:00:52 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"142a018c4b1927d5114eb834f0629173"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"299a2d53-f087-40a7-a471-c209dfd40dc7"},{"name":"resumeCampaign","id":"4616312b-6571-4270-9b49-fd9873a10a4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1322","type":"text","description":"Integer. Required.
\nThe automated campaign ID. Use the searchCampaigns method to retrieve the list of available automated campaigns. The minimum length is 1 digit.
\n"}]},"url":"https://{{host}}/api/v2/outbound/resumeCampaign?domain={{domain}}","description":"Resumes an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v2","outbound","resumeCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"7e553118-7de3-46df-b917-406def04430b","name":"resumeCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"1322","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/outbound/resumeCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","outbound","resumeCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 18:02:24 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"2b5ceac2734414390b0b606e03080b11"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"4616312b-6571-4270-9b49-fd9873a10a4f"},{"name":"stopCampaign","id":"bc5cc25a-823e-4d67-b8e7-1e4566616324","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","type":"text","value":"6513","description":"Integer. Required.
\nThe automated campaign ID. Use the searchCampaigns method to retrieve the list of available automated campaigns. The minimum length is 1 digit.
\n"}]},"url":"https://{{host}}/api/v2/outbound/stopCampaign?domain={{domain}}","description":"Stops an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v2","outbound","stopCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"8c1059cb-61ed-4a0a-93aa-cb4b3e5b8b8e","name":"stopCampaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"6513","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/outbound/stopCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","outbound","stopCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 18:03:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c7d684e9289550cac18e2d7f4e456871"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"bc5cc25a-823e-4d67-b8e7-1e4566616324"},{"name":"searchCampaigns","id":"e52af2c9-6672-4d51-9a2d-7d12c3b9129c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"","type":"text","description":"String. Optional.
\nThe particular automated campaign name to filter.
\n","disabled":true},{"key":"status","value":"draft","description":"String. Optional.
\nThe campaign status to filter. The options are ready|processing|started|paused|draft|completed.
\n","type":"text"},{"key":"id","value":"","type":"text","description":"Integer. Optional.
\nThe particular campaign ID to filter. The minimum length is 1 digit.
\n","disabled":true},{"key":"folder_id","value":"","description":"Integer. Optional.
\nThe particular campaign storage folder ID to filter. The minimum length is 1 digit.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v2/outbound/searchCampaigns?domain={{domain}}&per-page=20&page=1&sort=-id","description":"Retrieves a list of automated campaigns.
\nIf you define specific query parameters, the request returns only the campaigns that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v2","outbound","searchCampaigns"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"20"},{"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"c04ea705-eb64-4511-9cce-bbf03f978488","name":"searchCampaigns","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"title","value":"","type":"text","disabled":true},{"key":"status","value":"draft","type":"text"},{"key":"id","value":"","type":"text","disabled":true},{"key":"folder_id","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v2/outbound/searchCampaigns?domain={{domain}}&page=1&per-page=20","protocol":"https","host":["{{host}}"],"path":["api","v2","outbound","searchCampaigns"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."},{"key":"page","value":"1","description":"int"},{"key":"per-page","value":"20","description":"optional, type=int, default=20, max=50\nОграничение количества записей в отчете"},{"key":"sort","value":"","description":"string, max=255","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 28 Mar 2023 18:17:15 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.3.33"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"f9ef57b045ca622dfb38c68452766cf7"},{"key":"X-Pagination-Total-Count","value":"2"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"title","type":"text","value":"Customer notification","description":"String. Required.
\nThe new automated campaign name. The minimum length is 1 character, maximum - 255.
\n"},{"key":"max_attempts","type":"text","value":"5","description":"Integer. Required.
\nThe maximum number of attempts to dial each customer within the campaign. If the campaign fails to reach a customer withthin the specified number of attempts, this customer is labelled 'unsuccessful' in the campaign statistics. The minimum value is 1, maximum - 5.
\n"},{"key":"interval","type":"text","value":"60","description":"Integer. Required.
\nThe interval (in minutes) between dialing attempts to each customer within the campaign.
\n"},{"key":"max_lines","type":"text","value":"1","description":"Integer. Required.
\nThe maximum number of calls the system can make simultaneously within the campaign. The minimum value is 1, maximum - 500.
\n"},{"key":"scenario_id","type":"text","value":"3979","description":"Integer. Required.
\nThe scenario ID that determines the campaign flow. Use the searchScenarios method to retrieve the list of available scenarios. The minimum length is 1 digit.
\n"},{"key":"folder_id","value":"","description":"Integer. Optional.
\nThe folder ID to store the campaign. The minimum length is 1.
\n","type":"text","disabled":true},{"key":"phone_number_id","type":"text","value":"268","description":"Integer. Required if caller_id and sip_number_id are empty.
\nThe identifier of the phone number to use for the campaign outbound calls. This is the ID of the phone number you purchased in Voximplant Kit. Use the searchNumbers method to retrieve available phone numbers.
\n"},{"key":"caller_id","type":"text","value":"","description":"Integer. Required if phone_number_id and sip_number_id are empty.
\nThe identifier of the Caller ID to use for the campaign outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"sip_number_id","value":"","description":"Integer. Required if caller_id and phone_number_id are empty.
\nThe identifier of the external number to use for the campaign outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.
\n","type":"text","disabled":true},{"key":"time_start","type":"text","value":"","description":"String. Optional.
\nThe start of working hours. The format is HH:mm:ss.
\n","disabled":true},{"key":"time_end","type":"text","value":"","description":"String. Optional.
\nThe end of working hours. The format is HH:mm:ss.
\n","disabled":true},{"key":"date_start","type":"text","value":"2023-09-20 00:00:00","description":"String. Optional.
\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign. The supported format is YYYY-MM-DD H:i:s.
\n"},{"key":"date_end","type":"text","value":"2023-10-20 00:00:00","description":"String. Optional.
\nThe date and time when the campaign should stop calling customers. Otherwise, the campaign continues calling customers until it uses all dialing attempts to each customer. The supported format is YYYY-MM-DD H:i:s.
\n"},{"key":"region_enabled","value":"true","description":"Boolean. Optional. Nullable.
\nSpecifies whether the region selection feature is enabled for the campaign. When enabled, you can specify the region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. The options are 1|0|true|false.
\n","type":"text"},{"key":"region","value":"usa","description":"String. Required if region_enabled is true.
\nThe region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. The options are usa|europe|south_america|singapore|russia|kazakhstan.
\n","type":"text"},{"key":"description","value":"New tariff plans","description":"String. Optional.
\nThe campaign description.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/outbound/initCampaign?domain={{domain}}","description":"Creates an automated campaign.
\n","urlObject":{"protocol":"https","path":["api","v3","outbound","initCampaign"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"1d6ad3cb-9239-4b69-a65e-c479c4ab63e3","name":"initCampaign","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.\n\nYour API token."},{"key":"title","type":"text","value":"Customer notification","description":"String. Required.\n\nThe new automated campaign name. The minimum length is 1 character, maximum - 255."},{"key":"max_attempts","type":"text","value":"5","description":"Integer. Required.\n\nThe maximum number of attempts to dial each customer within the campaign. If the campaign fails to reach a customer withthin the specified number of attempts, this customer is labelled 'unsuccessful' in the campaign statistics. The minimum value is 1, maximum - 20."},{"key":"interval","type":"text","value":"60","description":"Integer. Required.\n\nThe interval (in minutes) between dialing attempts to each customer within the campaign."},{"key":"max_lines","type":"text","value":"1","description":"Integer. Required.\n\nThe maximum number of calls the system can make simultaneously within the campaign. The minimum value is 1, maximum - 500"},{"key":"scenario_id","type":"text","value":"3979","description":"Integer. Required.\n\nThe scenario ID that determines the campaign flow. Use the searchScenarios method to retrieve the list of available scenarios. The minimum length is 1 digit."},{"key":"folder_id","value":"","description":"Integer. Optional. \n\nThe folder ID to store the campaign. The minimum length is 1.","type":"text","disabled":true},{"key":"phone_number_id","type":"text","value":"268","description":"Integer. Required if caller_id and sip_number_id are empty.\n\nThe identifier of the phone number to use for the campaign outbound calls. This is the ID of the phone number you purchased in Voximplant Kit. Use the searchNumbers method to retrieve available phone numbers.\n"},{"key":"caller_id","type":"text","value":"","description":"Integer. Required if phone_number_id and sip_number_id are empty.\n\nThe identifier of the Caller ID to use for the campaign outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.\n\n","disabled":true},{"key":"sip_number_id","value":"","description":"Integer. Required if caller_id and phone_number_id are empty.\n\nThe identifier of the external number to use for the campaign outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers. \n","type":"text","disabled":true},{"key":"time_start","type":"text","value":"","description":"String. Optional. \n\nThe start of working hours. The format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"time_end","type":"text","value":"","description":"String. Optional.\n\nThe end of working hours. The format is YYYY-MM-DD HH:mm:ss. ","disabled":true},{"key":"date_start","type":"text","value":"2023-09-20 00:00:00","description":"String. Optional.\n\nThe date and time when the campaign should start calling customers. Otherwise, calling starts immediately after you launch the campaign. The supported format is YYYY-MM-DD H:i:s.\n"},{"key":"date_end","type":"text","value":"2023-10-20 00:00:00","description":"String. Optional.\n\nThe date and time when the campaign should stop calling customers. Otherwise, the campaign continues calling customers until it uses all dialing attempts to each customer. The supported format is YYYY-MM-DD H:i:s.\n"},{"key":"region_enabled","value":"true","description":"Boolean. Optional. Nullable.\n\nSpecifies whether the region selection feature is enabled for the campaign. When enabled, you can specify the region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. The options are 1|0|true|false.","type":"text"},{"key":"region","value":"usa","description":"String. Required if region_enabled is true.\n\nThe region to launch the campaign. If you do not specify any region, the system determines it by the IP address of the region where you launch the campaign. The options are usa|europe|south_america|singapore|russia|kazakhstan.","type":"text"},{"key":"description","value":"New tariff plans","description":"String. Optional.\n\nThe campaign description.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/outbound/initCampaign?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","outbound","initCampaign"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 14 Jul 2023 09:17:34 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"fe7777a036132413ca63e39139d834a5"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 1068,\n \"title\": \"Customer notification\",\n \"description\": \"New tariff plans\",\n \"date_start\": \"2023-09-20 00:00:00\",\n \"date_end\": \"2023-10-20 00:00:00\",\n \"date_create\": \"2023-07-14 09:17:33\",\n \"date_update\": null,\n \"working_days\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7\n ],\n \"time_start\": \"\",\n \"time_end\": \"\",\n \"status\": \"ready\",\n \"max_attempts\": 5,\n \"interval\": 60,\n \"max_lines\": 1,\n \"author_id\": 1721,\n \"domain_id\": 169,\n \"scenario_id\": 3979,\n \"call_list_id\": 53805,\n \"phone_number_id\": 268,\n \"timezone\": \"UTC\",\n \"caller_id\": null,\n \"callerid_id\": null,\n \"permanent\": true,\n \"last_launch_status\": null,\n \"folder_id\": null,\n \"reference_ip\": \"173.237.12.68\",\n \"region_enabled\": true,\n \"sip_number_id\": null\n }\n}"}],"_postman_id":"ac01fe82-f490-40a7-a5d0-4bc778836552"}],"id":"7a49a69a-f33a-428f-88d4-60ccfde6ebdf","description":"This folder contains actions you may need to manage automated campaigns.
\nAn automated campaign is one of the main elements of automated calling. You can launch a customized call campaign based on a specific scenario and control it directly from Voximplant Kit.
\n","_postman_id":"7a49a69a-f33a-428f-88d4-60ccfde6ebdf"},{"name":"phone","item":[{"name":"updateNumber","id":"c6284506-2bb6-4654-9fa2-d6a10def2174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"268","type":"text","description":"Integer. Required.
\nThe phone number ID. Use the searchNumbers method to retrieve available phone numbers.
\n"},{"key":"redirect_number","value":"+1 747-212-0732","type":"text","description":"String. Optional. Nullable.
\nThe phone number to use for direct forwarding of inbound customer calls.
\n"},{"key":"description","value":"Can be used for VIP customers only.","description":"String. Optional. Nullable.
\nAny additional information you want to add to the phone number.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/phone/updateNumber?domain={{domain}}","description":"Updates a phone number.
\n","urlObject":{"protocol":"https","path":["api","v3","phone","updateNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"80382fa5-f206-4ee0-87d8-25795bd75d5f","name":"updateNumber","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"268","type":"text"},{"key":"redirect_number","value":"+1 747-212-0732","type":"text"},{"key":"description","value":"Can be used for VIP customers only.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/phone/updateNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","phone","updateNumber"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 13 Apr 2023 05:29:55 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"87347076752b821a5b4132bddfff3b09"},{"key":"Vary","value":"Accept"},{"key":"Set-Cookie","value":"_csrf=3f5e26105ec4184897be3d444949d3a591a315e8ccf504d0905de4d58aee656da%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22wuVIeo7YrImi9tbcz4bst4ljKgsGv0sF%22%3B%7D; path=/; HttpOnly; SameSite=Lax"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"c6284506-2bb6-4654-9fa2-d6a10def2174"},{"name":"searchNumbers","id":"aecd42da-ef09-4cca-9b16-068764d5f0be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"is_sms_enabled","value":"1","type":"text","description":"Integer. Optional.
\nSpecifies whether SMS messaging is enabled for the phone number. The options are 0|1.
\n","disabled":true},{"key":"is_sms_supported","value":"1","type":"text","description":"Integer. Optional.
\nSpecifies whether the phone number supports SMS messaging. The options are 0|1.
\n","disabled":true},{"key":"category_name","value":"","type":"text","description":"String. Optional.
\nThe particular phone number category to filter. See the https://voximplant.com/docs/references/httpapi/phonenumbers#getphonenumbercategories method to retrieve the available phone number categories.
\n","disabled":true},{"key":"phone_number","value":"+1 747-212-0731","type":"text","description":"String. Optional.
\nThe particular phone number to filter.
\n","disabled":true},{"key":"phone_region_id","value":"36","type":"text","description":"Integer. Optional.
\nThe particular phone number country region ID to filter. Use the https://voximplant.com/docs/references/httpapi/phonenumbers#getphonenumberregions method to retrieve the available country regions and their IDs.
\n","disabled":true},{"key":"allowed_callerids","value":"1","type":"text","description":"Integer. Optional.
\nSpecifies whether the phone number can be used as a Caller ID. The options are 0|1.
\n","disabled":true},{"key":"keyword","value":"+7900","description":"String. Optional.
\nA keyword (number or description) to filter.
\n","type":"text","disabled":true},{"key":"id","value":"268","description":"Integer. Optional.
\nThe particular phone number ID to filter.
\n","type":"text","disabled":true},{"key":"redirect_number","value":"8900","description":"String. Optional.
\nThe redirect phone number.
\n","type":"text","disabled":true},{"key":"phone_country_code","value":"US","description":"String. Optional.
\nThe phone number country code (2 symbols), for example: RU, US, KZ, CA, etc.
\n","type":"text","disabled":true},{"key":"canceled","value":"0","description":"Integer. Optional.
\nSpecifies whether the subscription is canceled (deleted). The options are 0|1.
\n","type":"text","disabled":true},{"key":"deactivated","value":"0","description":"Integer. Optional.
\nSpecifies whether the subscription is deactivated (frozen). The options are 0|1.
\n","type":"text","disabled":true},{"key":"can_be_used","value":"0","description":"Integer. Optional.
\nSpecifies whether the phone number can be used for the account. The options are 0|1.
\n","type":"text","disabled":true},{"key":"auto_charge","value":"0","description":"Integer. Optional.
\nThe auto_charge flag to filter. The options are 0|1.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/phone/searchNumbers?domain={{domain}}&page=1&per-page=10","description":"Retrieves a list of phone numbers used in the account.
\nIf you define specific query parameters, the request only retrieves the numbers that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","phone","searchNumbers"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-phone_country_code"},{"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"10"}],"variable":[]}},"response":[{"id":"d5755165-5ce6-42f8-b0b2-cd414721332a","name":"searchNumbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"is_sms_enabled","value":"1","type":"text","disabled":true},{"key":"is_sms_supported","value":"1","type":"text","disabled":true},{"key":"category_name","value":"TOLLFREE","type":"text","disabled":true},{"key":"phone_number","value":"+1 747-212-0731","type":"text","disabled":true},{"key":"phone_region_id","value":"36","type":"text","disabled":true},{"key":"allowed_callerids","value":"1","type":"text","disabled":true},{"key":"keyword","value":"+7900","type":"text","disabled":true},{"key":"id","value":"268","type":"text"},{"key":"redirect_number","value":"8900","type":"text","disabled":true},{"key":"phone_country_code","value":"US","type":"text","disabled":true},{"key":"canceled","value":"0","type":"text","disabled":true},{"key":"deactivated","value":"0","type":"text","disabled":true},{"key":"can_be_used","value":"0","type":"text","disabled":true},{"key":"auto_charge","value":"0","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/phone/searchNumbers?domain={{domain}}&per-page=10&page=1","protocol":"https","host":["{{host}}"],"path":["api","v3","phone","searchNumbers"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."},{"key":"per-page","value":"10","description":"Integer. Optional.\n\nThe number of records per page."},{"key":"sort","value":"-phone_country_code","description":"The sorting criteria.","disabled":true},{"key":"page","value":"1","description":"Integer. Optional.\n\nThe number of pages."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 11 May 2023 11:17:33 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"1102c9b8d091006d09f3c86871af060c"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"10"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"611","type":"text","description":"Integer. Required.
\nThe phone number ID. Use the searchNumbers method to retrieve the list of available phone numbers.
\n"}]},"url":"https://{{host}}/api/v2/phone/removePhoneNumber?domain={{domain}}","description":"Removes a phone number from the account.
\n","urlObject":{"protocol":"https","path":["api","v2","phone","removePhoneNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"0b4c0294-4cc9-4d41-a9c6-b939fc9351b8","name":"removePhoneNumber","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"611","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/phone/removePhoneNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","phone","removePhoneNumber"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 13 Apr 2023 05:31:58 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"cbcb3ee869f0a352fb3d1d5136fe8ab2"},{"key":"Vary","value":"Accept"},{"key":"Set-Cookie","value":"_csrf=ffa1bb4ece8dbc7d30b1618fee0b16d672414a912240a006cefd7d87ca72ef78a%3A2%3A%7Bi%3A0%3Bs%3A5%3A%22_csrf%22%3Bi%3A1%3Bs%3A32%3A%22MejYUygWQcdfylWpvyJIB6ycOADEutWP%22%3B%7D; path=/; HttpOnly; SameSite=Lax"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"d0de89f6-cfee-49f0-b69e-217168bfdfa0"}],"id":"b65f551f-e69d-4e53-9b5b-aa240a033ccd","description":"The folder contains actions you may need to manage the phone numbers purchased in Voximplant Kit.
\n","_postman_id":"b65f551f-e69d-4e53-9b5b-aa240a033ccd"},{"name":"queues","item":[{"name":"addQueue","id":"4f5a7b92-972e-4122-8275-edb61c4aebfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"acd_queue_title","value":"Support 2nd line","type":"text","description":"String. Required.
\nThe queue name.
\n"},{"key":"call_agent_selection","value":"MAX_WAITING_TIME","type":"text","description":"String. Required.
\nThe queue agent priority strategy (calls). This is the priority of processing inbound calls based on the agent's maximum waiting time or qualification level.
\nThe options are:
\nString. Required.
\nThe agent selection strategy when it is not possible to wait till a preferred agent gets available. The parameter accepts only NONE, which means that the system will not attempt to route a conversation to a fallback agent.
\n"},{"key":"call_task_selection","value":"MAX_PRIORITY","type":"text","description":"String. Required.
\nThe queue request priority strategy (calls). This is the priority of processing an inbound call based on its priority level or its time in the queue.
\nThe options are:
\nString. Optional.
\nThe queue description.
\n","disabled":true},{"key":"im_agent_selection","value":"MAX_WAITING_TIME","type":"text","description":"String. Required.
\nThe queue agent priority strategy (messaging). This is the priority of processing inbound conversations based on the agent's maximum waiting time or qualification level.
\nThe options are:
\nString. Required.
\nThe queue request priority strategy (messaging). This is the priority of processing an inbound conversation based on its priority level or its time in the queue.
\nThe options are:
\nInteger. Optional.
\nThe queue extension number. The minimum length is 1 digit, and the maximum is 9999999999.
\n","disabled":true},{"key":"im_sl_waiting_time_sec","value":"1","type":"text","description":"Integer. Optional.
\nThe queue SL-period for messaging. This is the threshold time customers wait in the queue for an available agent, required for the queue service level (SL) calculation. By default, the queue SL-period is 20 seconds. The minimum value is 1 sec, and the maximum is 999.
\n","disabled":true},{"key":"call_sl_waiting_time_sec","value":"1","type":"text","description":"Integer. Optional.
\nThe queue SL-period for calls. This is the threshold time customers wait in the queue for an available agent, required for the queue service level (SL) calculation. By default, the queue SL-period is 20 seconds. The minimum value is 1 sec, and the maximum is 999.
\n","disabled":true},{"key":"agents_can_end_calls","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether the queue agents can end external calls. The default setting is true.
\n","disabled":true},{"key":"agents_can_decline_calls","value":"false","description":"Boolean. Optional.
\nSpecifies whether the queue agents can decline external calls. The default setting is true.
\n","type":"text","disabled":true},{"key":"supervisors","value":"[{\"supervisor_id\":1643,\"permission\":\"editor\"},{\"supervisor_id\":1644,\"permission\":\"viewer\"}]","description":"JSON (object array, permission: editor|viewer). Optional.
\nThe queue supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as queue supervisors.
\nThe available permissions are:
\nViewer - A supervisor can monitor performance indicators of the assigned queues but cannot manage the queue agents.
\nEditor - A supervisor can monitor performance indicators of the assigned queues and can assign/unassign their group agents to/from these queues (in the Live monitoring section).
\nBoolean. Optional.
\nSpecifies whether hold notifications are enabled for the current queue. The default value is false.
\n","disabled":true},{"key":"hold_notification_time_sec","value":"89","type":"text","description":"Integer. Optional.
\nThe threshold time when the queue agents recieve a reminder that a customer is on hold. The minimum value is 1 second, the maximum is 120. The default value is 30 sec.
\n","disabled":true},{"key":"hold_notification_settings_overridden","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether you can set up hold notifications for the current queue. This setting overrides the general contact center settings. The default value is false.
\n","disabled":true},{"key":"priority","value":"1","description":"Integer. Optional.
\nThe queue priority. The setting determines how much longer requests from this queue should wait for an agent if compared to requests from other queues. The available values are from 1 to 10. The higher the priority of the queue, the lower the value must be specified in the setting. The default queue priority is 10.
\n","type":"text","disabled":true},{"key":"call_max_waiting_time","value":"30","description":"Integer. Optional.
\nThe queue maximum waiting time (calls). This is the longest time a customer waits in the queue for an available agent. When this time is over, the call is terminated and goes through the Fail port of the Call to queue scenario block. The default value is 120 min.
\n","type":"text","disabled":true},{"key":"im_max_waiting_time","value":"30","description":"Integer. Optional.
\nThe queue maximum waiting time (messaging). This is the longest time a customer waits in the queue for an available agent. When this time is over, the system adds the request to the Unassigned list. The default value is 120 min.
\n","type":"text","disabled":true},{"key":"call_max_queue_size","value":"500","description":"Integer. Optional.
\nThe maximum queue size (calls). This is the maximum number of customers that can simultaneously wait in the queue. All customer requests beyond this limit are terminated and go through the Fail port of the Call to queue scenario block. The default value is 1000.
\n","type":"text","disabled":true},{"key":"im_max_queue_size","value":"500","description":"Integer. Optional.
\nThe maximum queue size. This is the maximum number of customers that can simultaneously wait in the queue. All customer requests beyond this limit are added to the Unassigned list. The default value is 1000.
\n","type":"text","disabled":true},{"key":"call_auto_answer","value":"true","description":"Boolean. Optional.
\nSpecifies whether the system automatically connects the queue agents to customers. The default setting is false.
\n","type":"text","disabled":true},{"key":"max_autoservice_time_enabled","value":"true","description":"Boolean. Optional.
\nSpecifies whether the queue agents have limited time on post-call activities (after service). The default setting is false.
\n","type":"text","disabled":true},{"key":"max_autoservice_time_sec","value":"2","description":"Integer. Optional.
\nThe maximum time the queue agents can spend on post-call activities (after service). The maximum value is 3600 seconds, the default value is 0.
\n","type":"text","disabled":true},{"key":"acd_establish_timeout_sec","value":"600","description":"Integer. Optional.
\nThe queue maximum reaction time (messaging). This is the longest time from the moment the system assigns a conversation to an agent until an agent sends the first message to a customer. When the time is over, the request returns to the queue, and the system assigns it to another agent. The minimum value is 10 seconds, the maximum is 3600. The default value is 600 sec.
\n","type":"text","disabled":true},{"key":"acd_reply_timeout_sec","value":"600","description":"Integer. Optional.
\nThe maximum agent silence time (messaging). This is the longest time it takes an agent to respond to the latest customer message. When this time is over, the system adds this conversation to the Unassigned list. The minimum value is 10 seconds, the maximum is 3600. The default value is 600 sec.
\n","type":"text","disabled":true},{"key":"acd_client_timeout_sec","value":"3600","description":"Integer. Optional.
\nThe maximum customer silence time. This is the longest time it takes a customer to respond to the latest agent message. The system closes the conversation once this time is over. The minimum value is 600 seconds, the maximum is 86400. The default value is 3600 sec.
\n","type":"text","disabled":true},{"key":"autoreplies","value":"{\"agents\":{\"welcome_message\":{\"enabled\":\"true\",\"messages\":[\"Hello, my name is {{agent_name}} and I will provide further assistance. I’ll need some time to prepare an answer. Please wait.\",\"after_transfer_message\":{\"enabled\":\"false\"},\"answer_timeout_message\":{\"enabled\":\"false\"}},\"queue\":{\"added_to_queue\":{\"enabled\":\"true\",\"messages\":[\"Hello! Thank you for contacting us. One of our agents will help you soon.\"]},\"all_agents_offline\":{\"enabled\":\"false\"}}}","description":"JSON (object). Optional.
\nThe queue automatic messages (auto-replies). If you want to enable a specific auto-reply, set \"enabled\":\"true\". To disable an auto-reply, set \"enabled\":\"false\".
\nGeneral messages:\nchat_closed_by_timeout - A message delivered to a customer when the chat is closed by the timeout defined in the Close channel conversations settings for agent, bot, and unassigned conversations.
\nQueue messages:\nadded_to_queue - A greeting message to a customer informing them that their request has been added to a queue.\nno_agents_available - A message to a customer informing them that all agents are currently unavailable (Offline, DND, Banned, or custom statuses).
\nAgents' messages:\nwelcome_message - A greeting message to a customer on behalf of an agent that the request has been assigned to.\nafter_transfer_message - A message to a customer on behalf of an agent that the request has been transferred to.\nanswer_timeout_message - A message to a customer when the maximum agent's response waiting time elapses.\nchat_closed_by_agent - A message delivered to a customer when an agent closes their chat.
\nBoolean. Optional.
\nSpecifies what should happen to a call in the queue if no agents are available (Banned, DND, custom statuses).
\nIf set to true, the call goes through the \"Fail\" port in the \"Call to queue\" block.
\nIf set to false, the call continues to wait in the queue until the maximum waiting time is reached or until an agent becomes available.
\nThe default value is false.
\n","type":"text","uuid":"49a98ec6-d766-4b9f-8504-1bf449cecdd8","disabled":true}]},"url":"https://{{host}}/api/v3/queues/addQueue?domain={{domain}}","description":"Creates a queue.
\n","urlObject":{"protocol":"https","path":["api","v3","queues","addQueue"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"27c99481-94ec-4460-ac2f-33c7556d0e3d","name":"addQueue","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"acd_queue_title","value":"Support 2nd line","type":"text"},{"key":"call_agent_selection","value":"MAX_WAITING_TIME","type":"text"},{"key":"fallback_agent_selection","value":"NONE","type":"text"},{"key":"call_task_selection","value":"MAX_PRIORITY","type":"text"},{"key":"description","value":"description","type":"text","disabled":true},{"key":"im_agent_selection","value":"MAX_WAITING_TIME","type":"text"},{"key":"im_task_selection","value":"MAX_PRIORITY","type":"text"},{"key":"number_extension","value":"1111423","type":"text","disabled":true},{"key":"im_sl_waiting_time_sec","value":"1","type":"text","disabled":true},{"key":"call_sl_waiting_time_sec","value":"1","type":"text","disabled":true},{"key":"agents_can_end_calls","value":"false","type":"text","disabled":true},{"key":"agents_can_decline_calls","value":"false","type":"text","disabled":true},{"key":"supervisors","value":"[{\"supervisor_id\":1643,\"permission\":\"editor\"},{\"supervisor_id\":1644,\"permission\":\"viewer\"}]","type":"text","disabled":true},{"key":"hold_notification_enabled","value":"true","type":"text","disabled":true},{"key":"hold_notification_time_sec","value":"89","type":"text","disabled":true},{"key":"hold_notification_settings_overridden","value":"true","type":"text","disabled":true},{"key":"priority","value":"1","type":"text","disabled":true},{"key":"call_max_waiting_time","value":"30","type":"text","disabled":true},{"key":"im_max_waiting_time","value":"30","type":"text","disabled":true},{"key":"call_max_queue_size","value":"500","type":"text","disabled":true},{"key":"im_max_queue_size","value":"500","type":"text","disabled":true},{"key":"call_auto_answer","value":"true","type":"text","disabled":true},{"key":"max_autoservice_time_enabled","value":"true","type":"text","disabled":true},{"key":"max_autoservice_time_sec","value":"2","type":"text","disabled":true},{"key":"acd_establish_timeout_sec","value":"600","type":"text","disabled":true},{"key":"acd_reply_timeout_sec","value":"600","type":"text","disabled":true},{"key":"acd_client_timeout_sec","value":"3600","type":"text","disabled":true},{"key":"autoreplies","value":"{\"agents\":{\"welcome_message\":{\"enabled\":\"true\",\"messages\":[\"Hello, my name is {{agent_name}} and I will provide further assistance. I’ll need some time to prepare an answer. Please wait.\",\"after_transfer_message\":{\"enabled\":\"false\"},\"answer_timeout_message\":{\"enabled\":\"false\"}},\"queue\":{\"added_to_queue\":{\"enabled\":\"true\",\"messages\":[\"Hello! Thank you for contacting us. One of our agents will help you soon.\"]},\"all_agents_offline\":{\"enabled\":\"false\"}}}","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/queues/addQueue?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","queues","addQueue"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 10:21:12 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"86e99f8ec4e024a905ad4c89205a4a38"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 3830,\n \"acd_queue_id\": 3769,\n \"acd_queue_name\": \"Queue 12\",\n \"acd_queue_title\": \"Support 2nd line\",\n \"acd_max_conversations\": null,\n \"call_agent_selection\": \"MAX_WAITING_TIME\",\n \"domain_id\": 169,\n \"fallback_agent_selection\": \"NONE\",\n \"call_task_selection\": \"MAX_PRIORITY\",\n \"description\": null,\n \"create_date\": \"Wed May 24 2023 10:21:12 GMT+0000\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"deleted\": false,\n \"im_agent_selection\": \"MAX_WAITING_TIME\",\n \"im_task_selection\": \"MAX_PRIORITY\",\n \"call_max_waiting_time\": 120,\n \"call_max_queue_size\": 1000,\n \"im_max_waiting_time\": 120,\n \"im_max_queue_size\": 1000,\n \"acd_establish_timeout_sec\": 600,\n \"acd_reply_timeout_sec\": 600,\n \"max_simultaneous_conversations\": 5,\n \"max_autoservice_time_enabled\": 0,\n \"max_autoservice_time_sec\": 0,\n \"call_auto_answer\": false,\n \"agents_can_decline_calls\": true,\n \"acd_client_timeout_sec\": 3600,\n \"agent_campaign_id\": null,\n \"queue_dialing_media_enabled\": null,\n \"queue_dialing_media_id\": null,\n \"im_sl_waiting_time_sec\": 20,\n \"call_sl_waiting_time_sec\": 20,\n \"priority\": 10,\n \"number_extension\": null,\n \"agents_can_end_calls\": true,\n \"supervisors\": null,\n \"hold_notification_settings_overridden\": false,\n \"hold_notification_enabled\": false,\n \"hold_notification_time_sec\": 30\n }\n}"}],"_postman_id":"4f5a7b92-972e-4122-8275-edb61c4aebfe"},{"name":"searchQueues","id":"653ee0c5-4944-4ede-b545-45ad78d3324d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"with_users","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include users. The default setting is false.
\n"},{"key":"id","value":"956","type":"text","description":"Integer. Optional.
\nThe particular queue ID to filter.
\n"},{"key":"acd_queue_title","value":"title","type":"text","description":"String. Optional.
\nThe particular queue name to filter. The maximum length is 100 characters.
\n","disabled":true},{"key":"agent_campaign_id","value":"44","type":"text","description":"Integer. Optional.
\nThe particular PDS campaign ID to filter. Use the searchCampaigns method to retrieve the list of PDS campaigns.
\n","disabled":true},{"key":"with_supervisors","value":"true","description":"Boolean. Optional.
\nSpecifies whether the report should include supervisors.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/queues/searchQueues?domain={{domain}}","description":"Retrieves a list of available queues.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","queues","searchQueues"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"2b33257a-536d-4378-9a5b-251601e68d24","name":"searchQueues","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"with_users","value":"true","type":"text"},{"key":"id","value":"956","type":"text"},{"key":"acd_queue_title","value":"title","type":"text","disabled":true},{"key":"agent_campaign_id","value":"44","type":"text","disabled":true},{"key":"hide_agent_campaign_queues","value":"false","type":"text","disabled":true},{"key":"with_supervisors","value":"true","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/queues/searchQueues?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","queues","searchQueues"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 10:28:11 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"59378a4aba2ab23d334305e5ffefe248"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"669","type":"text","description":"Integer. Required.
\nThe queue ID. Use the searchQueues method to retrieve the list of available queues.
\n"}]},"url":"https://{{host}}/api/v3/queues/deleteQueue?domain={{domain}}","description":"Deletes a queue.
\n","urlObject":{"protocol":"https","path":["api","v3","queues","deleteQueue"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"4da1d2f0-f35d-4f3f-8e48-306896641988","name":"deleteQueue","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"669","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/queues/deleteQueue?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","queues","deleteQueue"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 10:32:12 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c0dedf16d3d0fb3b9de720c1305c8a4e"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"e434b10a-2953-4497-832d-e5ca9b455a5d"},{"name":"updateQueue","id":"98be222d-819f-4317-9b17-c3c685378084","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"3830","type":"text","description":"Integer. Required.
\nThe queue ID. Use the searchQueues method to retrieve the list of available queues.
\n","contentType":""},{"key":"acd_queue_title","value":"Support 2nd line","type":"text","description":"String. Optional.
\nThe queue name.
\n"},{"key":"call_agent_selection","value":"MOST_QUALIFIED","type":"text","description":"String. Optional.
\nThe queue agent priority strategy (calls). This is the priority of processing inbound calls based on the agent's maximum waiting time or qualification level.
\nThe options are:
\nString. Optional.
\nThe agent selection strategy when it is not possible to wait till a preferred agent gets available. The parameter accepts only NONE, which means that the system will not attempt to route a conversation to a fallback agent.
\n","disabled":true},{"key":"call_task_selection","value":"MAX_PRIORITY","type":"text","description":"String. Required.
\nThe queue request priority strategy (calls). This is the priority of processing an inbound call based on its priority level or its time in the queue.
\nThe options are:
\nString. Optional.
\nThe queue description.
\n","disabled":true},{"key":"im_agent_selection","value":"MOST_QUALIFIED","type":"text","description":"String. Optional.
\nThe queue agent priority strategy (messaging). This is the priority of processing inbound conversations based on the agent's maximum waiting time or qualification level.
\nThe options are:
\nString. Optional.
\nThe queue request priority strategy (messaging). This is the priority of processing an inbound conversation based on its priority level or its time in the queue.
\nThe options are:
\nBoolean. Optional.
\nSpecifies whether the queue agents can decline external calls. The default setting is true.
\n","disabled":true},{"key":"number_extension","value":"444","type":"text","description":"optional, nullable, int, min 1, max 9999999999 (Добавочный номер)
\n","disabled":true},{"key":"agents_can_end_calls","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether the queue agents can end external calls. The default setting is true.
\n","disabled":true},{"key":"im_sl_waiting_time_sec","value":"26","type":"text","description":"Integer. Optional.
\nThe queue SL-period for messaging. This is the threshold time customers wait in the queue for an available agent, required for the queue service level (SL) calculation. By default, the queue SL-period is 20 seconds. The minimum value is 1 sec, and the maximum is 999.
\n"},{"key":"call_sl_waiting_time_sec","value":"2","type":"text","description":"Integer. Optional.
\nThe queue SL-period for calls. This is the threshold time customers wait in the queue for an available agent, required for the queue service level (SL) calculation. By default, the queue SL-period is 20 seconds. The minimum value is 1 sec, and the maximum is 999.
\n"},{"key":"supervisors","value":"[{\"supervisor_id\":1643,\"permission\":\"editor\"},{\"supervisor_id\":1644,\"permission\":\"viewer\"}]","description":"JSON (object array, permission: editor|viewer). Optional.
\nThe queue supervisor IDs and permissions. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as queue supervisors.
\nThe available permissions are:
\nViewer - A supervisor can monitor performance indicators of the assigned queues but cannot manage the queue agents.
\nEditor - A supervisor can monitor performance indicators of the assigned queues and can assign/unassign their group agents to/from these queues (in the Live monitoring section).
\nBoolean. Optional.
\nSpecifies whether hold notifications are enabled for the current queue. The default value is false.
\n"},{"key":"hold_notification_time_sec","value":"89","type":"text","description":"Integer. Optional.
\nThe threshold time when the queue agents recieve a reminder that a customer is on hold. The minimum value is 1 second, the maximum is 120. The default value is 30 sec.
\n"},{"key":"hold_notification_settings_overridden","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether you can set up hold notifications for the current queue. This setting overrides the general contact center settings. The default value is false.
\n"},{"key":"priority","value":"1","description":"Integer. Optional.
\nThe queue priority. The setting determines how much longer requests from this queue should wait for an agent if compared to requests from other queues. The available values are from 1 to 10. The higher the priority of the queue, the lower the value must be specified in the setting. The default queue priority is 10.
\n","type":"text","disabled":true},{"key":"call_max_waiting_time","value":"30","description":"Integer. Optional.
\nThe queue maximum waiting time (calls). This is the longest time a customer waits in the queue for an available agent. When this time is over, the call is terminated and goes through the Fail port of the Call to queue scenario block. The default value is 120 min.
\n","type":"text","disabled":true},{"key":"im_max_waiting_time","value":"30","description":"Integer. Optional.
\nThe queue maximum waiting time (messaging). This is the longest time a customer waits in the queue for an available agent. When this time is over, the system adds the request to the Unassigned list. The default value is 120 min.
\n","type":"text","disabled":true},{"key":"call_max_queue_size","value":"500","description":"Integer. Optional.
\nThe maximum queue size (calls). This is the maximum number of customers that can simultaneously wait in the queue. All customer requests beyond this limit are terminated and go through the Fail port of the Call to queue scenario block. The default value is 1000.
\n","type":"text","disabled":true},{"key":"im_max_queue_size","value":"500","description":"Integer. Optional.
\nThe maximum queue size. This is the maximum number of customers that can simultaneously wait in the queue. All customer requests beyond this limit are added to the Unassigned list. The default value is 1000.
\n","type":"text","disabled":true},{"key":"call_auto_answer","value":"true","description":"Boolean. Optional.
\nSpecifies whether the system automatically connects the queue agents to customers. The default setting is false.
\n","type":"text","disabled":true},{"key":"max_autoservice_time_enabled","value":"true","description":"Boolean. Optional.
\nSpecifies whether the queue agents have limited time on post-call activities (after service). The default setting is false.
\n","type":"text","disabled":true},{"key":"max_autoservice_time_sec","value":"2","description":"Integer. Optional.
\nThe maximum time the queue agents can spend on post-call activities (after service). The maximum value is 3600 seconds, the default value is 0.
\n","type":"text","disabled":true},{"key":"acd_establish_timeout_sec","value":"600","description":"Integer. Optional.
\nThe queue maximum reaction time (messaging). This is the longest time from the moment the system assigns a conversation to an agent until an agent sends the first message to a customer. When the time is over, the request returns to the queue, and the system assigns it to another agent. The minimum value is 10 seconds, the maximum is 3600. The default value is 600 sec.
\n","type":"text","disabled":true},{"key":"acd_reply_timeout_sec","value":"600","description":"Integer. Optional.
\nThe maximum agent silence time (messaging). This is the longest time it takes an agent to respond to the latest customer message. When this time is over, the system adds this conversation to the Unassigned list. The minimum value is 10 seconds, the maximum is 3600. The default value is 600 sec.
\n","type":"text","disabled":true},{"key":"acd_client_timeout_sec","value":"3600","description":"Integer. Optional.
\nThe maximum customer silence time. This is the longest time it takes a customer to respond to the latest agent message. The system closes the conversation once this time is over. The minimum value is 600 seconds, the maximum is 86400. The default value is 3600 sec.
\n","type":"text","disabled":true},{"key":"autoreplies","value":"{\"agents\":{\"welcome_message\":{\"enabled\":\"true\",\"messages\":[\"Hello, my name is {{agent_name}} and I will provide further assistance. I’ll need some time to prepare an answer. Please wait.\",\"after_transfer_message\":{\"enabled\":\"false\"},\"answer_timeout_message\":{\"enabled\":\"false\"}},\"queue\":{\"added_to_queue\":{\"enabled\":\"true\",\"messages\":[\"Hello! Thank you for contacting us. One of our agents will help you soon.\"]},\"all_agents_offline\":{\"enabled\":\"false\"}}}","description":"JSON (object). Optional.
\nThe queue automatic messages (auto-replies). If you want to enable a specific auto-reply, set \"enabled\":\"true\". To disable an auto-reply, set \"enabled\":\"false\".
\nGeneral queue messages:\nadded_to_queue - A greeting message to a customer informing them that their request has been added to a queue.\nall_agents_offline - A message to a customer informing them that all agents are offline.
\nAgents' messages:\nwelcome_message - A greeting message to a customer on behalf of an agent that the request has been assigned to.\nafter_transfer_message - A message to a customer on behalf of an agent that the request has been transferred to.\nanswer_timeout_message - A message to a customer when the maximum agent's response waiting time elapses.
\nBoolean. Optional.
\nSpecifies what should happen to a call in the queue if no agents are available (Banned, DND, custom statuses).
\nIf set to true, the call goes through the \"Fail\" port in the \"Call to queue\" block.
\nIf set to false, the call continues to wait in the queue until the maximum waiting time is reached or until an agent becomes available.
\nThe default value is false.
\n","type":"text","uuid":"49a98ec6-d766-4b9f-8504-1bf449cecdd8","disabled":true}]},"url":"https://{{host}}/api/v3/queues/updateQueue?domain={{domain}}","description":"Updates a queue.
\n","urlObject":{"protocol":"https","path":["api","v3","queues","updateQueue"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"866370cf-021f-4e50-a1fd-0595ebc44d1a","name":"updateQueue","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"3830","type":"text"},{"key":"acd_queue_title","value":"Support 2nd line","type":"text"},{"key":"call_agent_selection","value":"MOST_QUALIFIED","type":"text"},{"key":"fallback_agent_selection","value":"NONE","type":"text","disabled":true},{"key":"call_task_selection","value":"MAX_PRIORITY","type":"text"},{"key":"description","value":"description","type":"text","disabled":true},{"key":"im_agent_selection","value":"MOST_QUALIFIED","type":"text","disabled":true},{"key":"im_task_selection","value":"MAX_PRIORITY","type":"text","disabled":true},{"key":"agents_can_decline_calls","value":"true","type":"text","disabled":true},{"key":"number_extension","value":"444","type":"text","disabled":true},{"key":"agents_can_end_calls","value":"false","type":"text","disabled":true},{"key":"im_sl_waiting_time_sec","value":"26","type":"text"},{"key":"call_sl_waiting_time_sec","value":"2","type":"text"},{"key":"supervisors","value":"[{\"supervisor_id\":1643,\"permission\":\"editor\"},{\"supervisor_id\":1644,\"permission\":\"viewer\"}]","type":"text","disabled":true},{"key":"hold_notification_enabled","value":"true","type":"text"},{"key":"hold_notification_time_sec","value":"89","type":"text"},{"key":"hold_notification_settings_overridden","value":"true","type":"text"},{"key":"priority","value":"1","type":"text","disabled":true},{"key":"call_max_waiting_time","value":"30","type":"text","disabled":true},{"key":"im_max_waiting_time","value":"30","type":"text","disabled":true},{"key":"call_max_queue_size","value":"500","type":"text","disabled":true},{"key":"im_max_queue_size","value":"500","type":"text","disabled":true},{"key":"call_auto_answer","value":"true","type":"text","disabled":true},{"key":"max_autoservice_time_enabled","value":"true","type":"text","disabled":true},{"key":"max_autoservice_time_sec","value":"2","type":"text","disabled":true},{"key":"acd_establish_timeout_sec","value":"600","type":"text","disabled":true},{"key":"acd_reply_timeout_sec","value":"600","type":"text","disabled":true},{"key":"acd_client_timeout_sec","value":"3600","type":"text","disabled":true},{"key":"autoreplies","value":"{\"agents\":{\"welcome_message\":{\"enabled\":\"true\",\"messages\":[\"Hello, my name is {{agent_name}} and I will provide further assistance. I’ll need some time to prepare an answer. Please wait.\",\"after_transfer_message\":{\"enabled\":\"false\"},\"answer_timeout_message\":{\"enabled\":\"false\"}},\"queue\":{\"added_to_queue\":{\"enabled\":\"true\",\"messages\":[\"Hello! Thank you for contacting us. One of our agents will help you soon.\"]},\"all_agents_offline\":{\"enabled\":\"false\"}}}","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/queues/updateQueue?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","queues","updateQueue"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 24 May 2023 10:45:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"67c99957d5aa59f978e1a9b4d5719fbf"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 3830,\n \"acd_queue_id\": 3769,\n \"acd_queue_name\": \"queue_name\",\n \"acd_queue_title\": \"Support 2nd line\",\n \"acd_max_conversations\": null,\n \"call_agent_selection\": \"MOST_QUALIFIED\",\n \"domain_id\": 169,\n \"fallback_agent_selection\": \"NONE\",\n \"call_task_selection\": \"MAX_PRIORITY\",\n \"description\": null,\n \"create_date\": \"Wed May 24 2023 10:21:12 GMT+0000\",\n \"created_by\": 1721,\n \"edit_date\": \"Wed May 24 2023 10:45:47 GMT+0000\",\n \"edited_by\": 1721,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"deleted\": false,\n \"im_agent_selection\": \"MAX_WAITING_TIME\",\n \"im_task_selection\": \"MAX_PRIORITY\",\n \"call_max_waiting_time\": 120,\n \"call_max_queue_size\": 1000,\n \"im_max_waiting_time\": 120,\n \"im_max_queue_size\": 1000,\n \"acd_establish_timeout_sec\": 600,\n \"acd_reply_timeout_sec\": 600,\n \"max_simultaneous_conversations\": 5,\n \"max_autoservice_time_enabled\": 0,\n \"max_autoservice_time_sec\": 0,\n \"call_auto_answer\": false,\n \"agents_can_decline_calls\": true,\n \"acd_client_timeout_sec\": 3600,\n \"agent_campaign_id\": null,\n \"queue_dialing_media_enabled\": null,\n \"queue_dialing_media_id\": null,\n \"im_sl_waiting_time_sec\": 26,\n \"call_sl_waiting_time_sec\": 2,\n \"priority\": 10,\n \"number_extension\": null,\n \"agents_can_end_calls\": true,\n \"supervisors\": null,\n \"hold_notification_settings_overridden\": true,\n \"hold_notification_enabled\": true,\n \"hold_notification_time_sec\": 89\n }\n}"}],"_postman_id":"98be222d-819f-4317-9b17-c3c685378084"}],"id":"994d58c0-37df-4dce-9737-b8dce8d2993a","description":"The folder contains actions you may need to manage queues.
\nA queue is the central element in the contact center. It is where customers virtually wait to interact with an agent.
\n","_postman_id":"994d58c0-37df-4dce-9737-b8dce8d2993a"},{"name":"realtime-metriсs","item":[{"name":"getAgentsMetricsCalls","id":"7c416c31-ed51-4005-8106-22d3d901180f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"interval","value":"last12h","description":"String. Required.
\nThe time span for which you want to review statistics. The options are since12am|last15m|last30m|last1h|last12h|last24h.
\n","type":"text"},{"key":"agent_ids","value":"[1774]","description":"JSON integer array. Required.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs.
\n","type":"text"},{"key":"timezone","value":"Europe/London","type":"text","description":"String. Optional.
\nThe particular timezone to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/realtimeMetrics/getAgentsMetricsCalls?domain={{domain}}","description":"Gets agent live statistics (calls).
\n","urlObject":{"protocol":"https","path":["api","v3","realtimeMetrics","getAgentsMetricsCalls"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"637c4285-6d3b-4721-a01a-989938b621ef","name":"getAgentsMetricsCalls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"interval","value":"last24h","type":"text"},{"key":"agent_ids","value":"[838]","type":"text"},{"key":"timezone","value":"Europe/London","type":"text","description":"String. Optional.\n\nThe particular timezone to filter.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/realtimeMetrics/getAgentsMetricsCalls?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","realtimeMetrics","getAgentsMetricsCalls"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Date","value":"Wed, 06 Jul 2022 08:05:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"stat\": {\n \"838\": {\n \"-last24h\": {\n \"from_date\": \"2022-07-04 08:05:27\",\n \"to_date\": \"2022-07-05 08:05:27\",\n \"interval\": \"-last24h\",\n \"metrics\": {\n \"domain_id\": 240,\n \"queue_id\": 0,\n \"user_id\": 838,\n \"total_transferred_calls\": 0,\n \"transferred_calls_rate\": 0,\n \"total_hold_calls\": 4,\n \"hold_calls_rate\": 44,\n \"avg_hold_time\": 68,\n \"min_hold_time\": 20,\n \"max_hold_time\": 120,\n \"all_agents\": 0,\n \"agents_in_ready\": 0,\n \"agents_in_service\": 0,\n \"unavailable_agents\": 0,\n \"calls_in_queue\": 0,\n \"distributed_calls\": 0,\n \"ongoing_calls\": 0,\n \"total_online_time\": 23202,\n \"total_ready_time\": 6099,\n \"total_dialing_time\": 102,\n \"total_in_service_time\": 133,\n \"total_after_service_time\": 226,\n \"total_dnd_time\": 2,\n \"total_banned_time\": 12,\n \"handled_calls\": 9,\n \"occupancy_rate\": 0.05,\n \"unanswered_calls\": 0,\n \"utilization_rate\": 0.22,\n \"min_reaction_time\": 2,\n \"max_reaction_time\": 24,\n \"avg_reaction_time\": 8,\n \"min_handle_time\": 2,\n \"max_handle_time\": 39,\n \"avg_handle_time\": 15,\n \"min_after_call_worktime\": 0,\n \"max_after_call_worktime\": 0,\n \"avg_after_call_worktime\": 0,\n \"lost_calls\": 0,\n \"lost_calls_rate\": 0,\n \"abandonment_calls\": 0,\n \"avg_abandonment_rate\": 0,\n \"service_level\": 0,\n \"avg_time_in_queue\": 0,\n \"min_time_in_queue\": 0,\n \"max_time_in_queue\": 0,\n \"min_answer_time\": 0,\n \"max_answer_time\": 0,\n \"avg_answer_time\": 0,\n \"min_after_service_time\": 1,\n \"max_after_service_time\": 117,\n \"avg_after_service_time\": 25,\n \"total_custom_1_time\": 0,\n \"total_custom_2_time\": 0,\n \"total_custom_3_time\": 0,\n \"total_custom_4_time\": 0,\n \"total_custom_5_time\": 0,\n \"total_custom_6_time\": 0,\n \"total_custom_7_time\": 0,\n \"total_custom_8_time\": 0,\n \"total_custom_9_time\": 0,\n \"total_custom_10_time\": 0\n }\n },\n \"last24h\": {\n \"from_date\": \"2022-07-05 08:05:27\",\n \"to_date\": \"2022-07-06 08:05:27\",\n \"interval\": \"last24h\",\n \"metrics\": {\n \"domain_id\": 240,\n \"queue_id\": 0,\n \"user_id\": 838,\n \"total_transferred_calls\": 0,\n \"transferred_calls_rate\": 0,\n \"total_hold_calls\": 0,\n \"hold_calls_rate\": 0,\n \"avg_hold_time\": 0,\n \"min_hold_time\": 0,\n \"max_hold_time\": 0,\n \"all_agents\": 0,\n \"agents_in_ready\": 0,\n \"agents_in_service\": 0,\n \"unavailable_agents\": 0,\n \"calls_in_queue\": 0,\n \"distributed_calls\": 0,\n \"ongoing_calls\": 0,\n \"total_online_time\": 26249,\n \"total_ready_time\": 42937,\n \"total_dialing_time\": 144,\n \"total_in_service_time\": 62,\n \"total_after_service_time\": 16,\n \"total_dnd_time\": 0,\n \"total_banned_time\": 12796,\n \"handled_calls\": 5,\n \"occupancy_rate\": 0,\n \"unanswered_calls\": 0,\n \"utilization_rate\": 0.53,\n \"min_reaction_time\": 4,\n \"max_reaction_time\": 19,\n \"avg_reaction_time\": 10,\n \"min_handle_time\": 7,\n \"max_handle_time\": 18,\n \"avg_handle_time\": 12,\n \"min_after_call_worktime\": 0,\n \"max_after_call_worktime\": 0,\n \"avg_after_call_worktime\": 0,\n \"lost_calls\": 0,\n \"lost_calls_rate\": 0,\n \"abandonment_calls\": 0,\n \"avg_abandonment_rate\": 0,\n \"service_level\": 0,\n \"avg_time_in_queue\": 0,\n \"min_time_in_queue\": 0,\n \"max_time_in_queue\": 0,\n \"min_answer_time\": 0,\n \"max_answer_time\": 0,\n \"avg_answer_time\": 0,\n \"min_after_service_time\": 1,\n \"max_after_service_time\": 9,\n \"avg_after_service_time\": 3,\n \"total_custom_1_time\": 0,\n \"total_custom_2_time\": 0,\n \"total_custom_3_time\": 0,\n \"total_custom_4_time\": 0,\n \"total_custom_5_time\": 0,\n \"total_custom_6_time\": 0,\n \"total_custom_7_time\": 0,\n \"total_custom_8_time\": 0,\n \"total_custom_9_time\": 0,\n \"total_custom_10_time\": 0\n }\n }\n }\n }\n }\n}"}],"_postman_id":"7c416c31-ed51-4005-8106-22d3d901180f"},{"name":"getAgentsGroupsMetricsCalls","id":"1ce094a6-9780-40d0-ba5f-efdc8f5fd6f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"interval","value":"last24h","type":"text","description":"String. Required.
\nThe time span for which you want to review statistics. The options are since12am|last15m|last30m|last1h|last12h|last24h.
\n"},{"key":"group_ids","value":"[519]","description":"JSON integer array. Required.
\nThe group IDs to include in the report. Use the searchGroups method to retrieve the list of available user groups.
\n","type":"text"},{"key":"timezone","value":"Europe/London","type":"text","description":"String. Optional.
\nThe particular timezone to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/realtimeMetrics/getAgentsGroupsMetricsCalls?domain={{domain}}","description":"Gets agent group live statistics (calls).
\n","urlObject":{"protocol":"https","path":["api","v3","realtimeMetrics","getAgentsGroupsMetricsCalls"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"47d9848b-d253-426b-bb08-13cdb8ca9a5a","name":"getAgentsMetricsCalls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"interval","value":"last24h","type":"text"},{"key":"agent_ids","value":"[838]","type":"text"},{"key":"timezone","value":"Europe/London","type":"text","description":"String. Optional.\n\nThe particular timezone to filter.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/realtimeMetrics/getAgentsMetricsCalls?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","realtimeMetrics","getAgentsMetricsCalls"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Date","value":"Wed, 06 Jul 2022 08:05:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"stat\": {\n \"838\": {\n \"-last24h\": {\n \"from_date\": \"2022-07-04 08:05:27\",\n \"to_date\": \"2022-07-05 08:05:27\",\n \"interval\": \"-last24h\",\n \"metrics\": {\n \"domain_id\": 240,\n \"queue_id\": 0,\n \"user_id\": 838,\n \"total_transferred_calls\": 0,\n \"transferred_calls_rate\": 0,\n \"total_hold_calls\": 4,\n \"hold_calls_rate\": 44,\n \"avg_hold_time\": 68,\n \"min_hold_time\": 20,\n \"max_hold_time\": 120,\n \"all_agents\": 0,\n \"agents_in_ready\": 0,\n \"agents_in_service\": 0,\n \"unavailable_agents\": 0,\n \"calls_in_queue\": 0,\n \"distributed_calls\": 0,\n \"ongoing_calls\": 0,\n \"total_online_time\": 23202,\n \"total_ready_time\": 6099,\n \"total_dialing_time\": 102,\n \"total_in_service_time\": 133,\n \"total_after_service_time\": 226,\n \"total_dnd_time\": 2,\n \"total_banned_time\": 12,\n \"handled_calls\": 9,\n \"occupancy_rate\": 0.05,\n \"unanswered_calls\": 0,\n \"utilization_rate\": 0.22,\n \"min_reaction_time\": 2,\n \"max_reaction_time\": 24,\n \"avg_reaction_time\": 8,\n \"min_handle_time\": 2,\n \"max_handle_time\": 39,\n \"avg_handle_time\": 15,\n \"min_after_call_worktime\": 0,\n \"max_after_call_worktime\": 0,\n \"avg_after_call_worktime\": 0,\n \"lost_calls\": 0,\n \"lost_calls_rate\": 0,\n \"abandonment_calls\": 0,\n \"avg_abandonment_rate\": 0,\n \"service_level\": 0,\n \"avg_time_in_queue\": 0,\n \"min_time_in_queue\": 0,\n \"max_time_in_queue\": 0,\n \"min_answer_time\": 0,\n \"max_answer_time\": 0,\n \"avg_answer_time\": 0,\n \"min_after_service_time\": 1,\n \"max_after_service_time\": 117,\n \"avg_after_service_time\": 25,\n \"total_custom_1_time\": 0,\n \"total_custom_2_time\": 0,\n \"total_custom_3_time\": 0,\n \"total_custom_4_time\": 0,\n \"total_custom_5_time\": 0,\n \"total_custom_6_time\": 0,\n \"total_custom_7_time\": 0,\n \"total_custom_8_time\": 0,\n \"total_custom_9_time\": 0,\n \"total_custom_10_time\": 0\n }\n },\n \"last24h\": {\n \"from_date\": \"2022-07-05 08:05:27\",\n \"to_date\": \"2022-07-06 08:05:27\",\n \"interval\": \"last24h\",\n \"metrics\": {\n \"domain_id\": 240,\n \"queue_id\": 0,\n \"user_id\": 838,\n \"total_transferred_calls\": 0,\n \"transferred_calls_rate\": 0,\n \"total_hold_calls\": 0,\n \"hold_calls_rate\": 0,\n \"avg_hold_time\": 0,\n \"min_hold_time\": 0,\n \"max_hold_time\": 0,\n \"all_agents\": 0,\n \"agents_in_ready\": 0,\n \"agents_in_service\": 0,\n \"unavailable_agents\": 0,\n \"calls_in_queue\": 0,\n \"distributed_calls\": 0,\n \"ongoing_calls\": 0,\n \"total_online_time\": 26249,\n \"total_ready_time\": 42937,\n \"total_dialing_time\": 144,\n \"total_in_service_time\": 62,\n \"total_after_service_time\": 16,\n \"total_dnd_time\": 0,\n \"total_banned_time\": 12796,\n \"handled_calls\": 5,\n \"occupancy_rate\": 0,\n \"unanswered_calls\": 0,\n \"utilization_rate\": 0.53,\n \"min_reaction_time\": 4,\n \"max_reaction_time\": 19,\n \"avg_reaction_time\": 10,\n \"min_handle_time\": 7,\n \"max_handle_time\": 18,\n \"avg_handle_time\": 12,\n \"min_after_call_worktime\": 0,\n \"max_after_call_worktime\": 0,\n \"avg_after_call_worktime\": 0,\n \"lost_calls\": 0,\n \"lost_calls_rate\": 0,\n \"abandonment_calls\": 0,\n \"avg_abandonment_rate\": 0,\n \"service_level\": 0,\n \"avg_time_in_queue\": 0,\n \"min_time_in_queue\": 0,\n \"max_time_in_queue\": 0,\n \"min_answer_time\": 0,\n \"max_answer_time\": 0,\n \"avg_answer_time\": 0,\n \"min_after_service_time\": 1,\n \"max_after_service_time\": 9,\n \"avg_after_service_time\": 3,\n \"total_custom_1_time\": 0,\n \"total_custom_2_time\": 0,\n \"total_custom_3_time\": 0,\n \"total_custom_4_time\": 0,\n \"total_custom_5_time\": 0,\n \"total_custom_6_time\": 0,\n \"total_custom_7_time\": 0,\n \"total_custom_8_time\": 0,\n \"total_custom_9_time\": 0,\n \"total_custom_10_time\": 0\n }\n }\n }\n }\n }\n}"}],"_postman_id":"1ce094a6-9780-40d0-ba5f-efdc8f5fd6f4"},{"name":"getQueuesMetricsCalls","id":"119c4e91-2aec-4313-974a-0afdefc99dc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"interval","value":"last30m","description":"String. Required.
\nThe time span for which you want to review statistics. The options are since12am|last15m|last30m|last1h|last12h|last24h.
\n","type":"text"},{"key":"queue_ids","value":"[2470]","description":"JSON integer array. Required.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues.
\n","type":"text"},{"key":"timezone","value":"Europe/London","type":"text","description":"String. Optional.
\nThe particular timezone to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/realtimeMetrics/getQueuesMetricsCalls?domain={{domain}}","description":"Gets queue statistics (calls).
\n","urlObject":{"protocol":"https","path":["api","v3","realtimeMetrics","getQueuesMetricsCalls"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"76d25f14-e2c0-46da-80dd-524a8f3c0ff6","name":"getQueuesMetricsCalls","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"interval","value":"last15m","type":"text"},{"key":"queue_ids","value":"[1369, 2111, 2123, 1430]","type":"text"},{"key":"timezone","value":"Europe/London","type":"text","description":"String. Optional.\n\nThe particular timezone to filter.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/realtimeMetrics/getQueuesMetricsCalls?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","realtimeMetrics","getQueuesMetricsCalls"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.3"},{"key":"Date","value":"Mon, 04 Jul 2022 07:53:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"from_date\": \"2022-07-04 07:38:22\",\n \"to_date\": \"2022-07-04 07:53:22\",\n \"interval\": \"last15m\",\n \"stat\": {\n \"1369\": {\n \"domain_id\": 240,\n \"queue_id\": 1369,\n \"user_id\": 10,13,16\n \"total_transferred_calls\": 43,\n \"transferred_calls_rate\": 10,\n \"total_hold_calls\": 8,\n \"hold_calls_rate\": 3,\n \"avg_hold_time\": 15,\n \"min_hold_time\": 9,\n \"max_hold_time\": 20,\n \"all_agents\": 183,\n \"agents_in_ready\": 98,\n \"agents_in_service\": 56,\n \"unavailable_agents\": 16,\n \"calls_in_queue\": 34,\n \"distributed_calls\": 5,\n \"ongoing_calls\": 16,\n \"total_online_time\": 60,\n \"total_ready_time\": 12,\n \"total_dialing_time\": 12,\n \"total_in_service_time\": 50,\n \"total_after_service_time\": 20,\n \"total_dnd_time\": 0,\n \"total_banned_time\": 0,\n \"handled_calls\": 0,\n \"occupancy_rate\": 90,\n \"unanswered_calls\": 5,\n \"utilization_rate\": 83,\n \"min_reaction_time\": 10,\n \"max_reaction_time\": 15,\n \"avg_reaction_time\": 12,\n \"min_handle_time\": 0,\n \"max_handle_time\": 0,\n \"avg_handle_time\": 0,\n \"min_after_call_worktime\": 0,\n \"max_after_call_worktime\": 0,\n \"avg_after_call_worktime\": 0,\n \"lost_calls\": 3,\n \"lost_calls_rate\": 3,\n \"abandonment_calls\": 15,\n \"avg_abandonment_rate\": 5,\n \"service_level\": 0,\n \"avg_time_in_queue\": 10,\n \"min_time_in_queue\": 2,\n \"max_time_in_queue\": 20,\n \"min_answer_time\": 2,\n \"max_answer_time\": 10,\n \"avg_answer_time\": 6,\n \"min_after_service_time\": 20,\n \"max_after_service_time\": 50,\n \"avg_after_service_time\": 25,\n \"total_custom_1_time\": 0,\n \"total_custom_2_time\": 0,\n \"total_custom_3_time\": 0,\n \"total_custom_4_time\": 0,\n \"total_custom_5_time\": 0,\n \"total_custom_6_time\": 0,\n \"total_custom_7_time\": 0,\n \"total_custom_8_time\": 0,\n \"total_custom_9_time\": 0,\n \"total_custom_10_time\": 0\n },\n \"1430\": {\n \"domain_id\": 240,\n \"queue_id\": 1430,\n \"user_id\": 17,234,583\n \"total_transferred_calls\": 43,\n \"transferred_calls_rate\": 10,\n \"total_hold_calls\": 8,\n \"hold_calls_rate\": 3,\n \"avg_hold_time\": 15,\n \"min_hold_time\": 9,\n \"max_hold_time\": 20,\n \"all_agents\": 183,\n \"agents_in_ready\": 98,\n \"agents_in_service\": 56,\n \"unavailable_agents\": 16,\n \"calls_in_queue\": 34,\n \"distributed_calls\": 5,\n \"ongoing_calls\": 16,\n \"total_online_time\": 60,\n \"total_ready_time\": 12,\n \"total_dialing_time\": 12,\n \"total_in_service_time\": 50,\n \"total_after_service_time\": 20,\n \"total_dnd_time\": 0,\n \"total_banned_time\": 0,\n \"handled_calls\": 0,\n \"occupancy_rate\": 90,\n \"unanswered_calls\": 5,\n \"utilization_rate\": 83,\n \"min_reaction_time\": 10,\n \"max_reaction_time\": 15,\n \"avg_reaction_time\": 12,\n \"min_handle_time\": 0,\n \"max_handle_time\": 0,\n \"avg_handle_time\": 0,\n \"min_after_call_worktime\": 0,\n \"max_after_call_worktime\": 0,\n \"avg_after_call_worktime\": 0,\n \"lost_calls\": 3,\n \"lost_calls_rate\": 3,\n \"abandonment_calls\": 15,\n \"avg_abandonment_rate\": 5,\n \"service_level\": 0,\n \"avg_time_in_queue\": 10,\n \"min_time_in_queue\": 2,\n \"max_time_in_queue\": 20,\n \"min_answer_time\": 2,\n \"max_answer_time\": 10,\n \"avg_answer_time\": 6,\n \"min_after_service_time\": 20,\n \"max_after_service_time\": 50,\n \"avg_after_service_time\": 25,\n \"total_custom_1_time\": 0,\n \"total_custom_2_time\": 0,\n \"total_custom_3_time\": 0,\n \"total_custom_4_time\": 0,\n \"total_custom_5_time\": 0,\n \"total_custom_6_time\": 0,\n \"total_custom_7_time\": 0,\n \"total_custom_8_time\": 0,\n \"total_custom_9_time\": 0,\n \"total_custom_10_time\": 0\n }\n }\n }\n}"}],"_postman_id":"119c4e91-2aec-4313-974a-0afdefc99dc9"}],"id":"4941dd56-a01e-42d1-acdd-34ee75a7beec","description":"This folder contains actions you may need to track the performance of your contact center agents, groups, and queues in real time.
\n","_postman_id":"4941dd56-a01e-42d1-acdd-34ee75a7beec"},{"name":"report","item":[{"name":"exportAgentHistoryReport","id":"b0ee6687-6440-43f6-b7e5-83167def8ae4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"date_from","value":"2022-11-30 00:00:00","type":"text","description":"String. Optional.
\nThe report start date. By default, the report is generated for the last hour before date_to. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"date_to","value":"2022-11-30 23:59:59","type":"text","description":"String. Optional.
\nThe report end date. By default, the end date is the current date and time. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"interval","value":"hour","type":"text","description":"String. Required.
\nThe period selected in the date_from and date_to parameters is split into intervals, and the system generates the report by these intervals. The options are hour|day|week|month|all.
\nIf you specify 'all' in this parameter, the system generates the report for the whole period between date_from and date_to.
\n"},{"key":"user_ids","value":"[118]","type":"text","description":"JSON array. Optional.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs. By default, the report includes all users.
\n"}]},"url":"https://{{host}}/api/v3/report/exportAgentHistoryReport?domain={{domain}}","description":"Generates an agent report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportAgentHistoryReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"ed77cc0d-c0e2-490f-825b-7b5b33174a43","name":"exportAgentHistoryReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"xlsx","type":"text"},{"key":"date_from","value":"2022-11-30 00:00:00","type":"text"},{"key":"date_to","value":"2022-11-30 23:59:59","type":"text"},{"key":"interval","value":"hour","type":"text"},{"key":"user_ids","value":"[118]","type":"text"},{"key":"queue_ids","value":"[1,2,3]","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/report/exportAgentHistoryReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportAgentHistoryReport"],"query":[{"key":"domain","value":"{{domain}}","description":"Yor account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 09:44:31 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"6aa0fd81f0ded5a7032a5db4b6588809"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 4959\n }\n}"}],"_postman_id":"b0ee6687-6440-43f6-b7e5-83167def8ae4"},{"name":"downloadReport","id":"5f8e95d1-a16f-4e2a-a82b-e69498e9e19a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"report_id","value":"4960","type":"text","description":"Integer. Required.
\nThe report ID. The maximum length is 2147483647 digits, the minimum is 1.
\nDepending on the report type, use one of the report exporting methods to get the report ID. For example, exportAgentHistoryReport, exportQueueHistoryReport, exportTagsReport, exportCampaignReport, exportAgentCampaignReport, exportAgentCampaignAttemptsReport, etc.
\n"}]},"url":"https://{{host}}/api/v3/report/downloadReport?domain={{domain}}","description":"Downloads a report.
\n","urlObject":{"protocol":"https","path":["api","v3","report","downloadReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c68e7621-47fb-46fc-a427-67d4cd41508d","name":"downloadReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"report_id","value":"4959","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/downloadReport","protocol":"https","host":["{{host}}"],"path":["api","v3","report","downloadReport"],"query":[{"key":"domain","value":"{{domain}}","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 09:56:12 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"173656"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"44bf803375dbf0fe1e46f50a69b26fe1"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Pragma","value":"public"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"must-revalidate, post-check=0, pre-check=0"},{"key":"Content-Disposition","value":"attachment; filename=\"report_4959.xlsx\""},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"Report file data"},{"id":"e6c69662-662a-49df-9771-960d4ab8196a","name":"downloadReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"d7b25aba3c3b73f06bd300799671f327bd55bc29ed42ac22cacc0acb66011b27","type":"text"},{"key":"report_id","value":"6623","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/downloadReport?domain=testdev2210","protocol":"https","host":["{{host}}"],"path":["api","v3","report","downloadReport"],"query":[{"key":"domain","value":"testdev2210"}]}},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"Server","value":"nginx/1.24.0"},{"key":"Date","value":"Thu, 18 Jan 2024 14:42:40 GMT"},{"key":"Content-Type","value":"application/octet-stream"},{"key":"Content-Length","value":"38035"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.9"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"0dba9987dd5c27ac3de718937c699656"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Pragma","value":"public"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Expires","value":"0"},{"key":"Cache-Control","value":"must-revalidate, post-check=0, pre-check=0"},{"key":"Content-Disposition","value":"attachment; filename=\"report_6623.xlsx\""}],"cookie":[],"responseTime":null,"body":"PK\u0003\u0004\u0014\u0000\b\u0000\b\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0018\u0000\u0000\u0000xl/worksheets/sheet2.xml��ݎ$�u����\"������(�\u001c�D��\u001c�/\u0004�l�� Y����FVv�e�\u0000%\u0018�\r]�6\f\u001b0`\u0018�'���@�\u0007�\nYod�GT�8{��^��أi����赢#bE.R?�W?������7/�^���ş\\vu���ݗ/_���������������?����7o���}���շ������\u001f\u001e�{��\u0017o^|}���͟�}w���W�������Û?����7����|���շ_,���_��y���\u000f\n�n�sD�~��/n~���W��\u001f>����p����/?���������o��wO\u0016}�����W�䍣����o^��*��|��\u0017_��?|\u0012����\u0012?��>)ݽ�����^}w���W/�}��G�/�z�\u0004�/_�|u��(��S�����7�_����\u001fn>���˧(}�������G�\u001f�d��4��Բ�����7\u000f/�^����w��\u0011�������{��Q�J.Szu���'�\u001c��5�ͷ�������������\"���_����w��=��k}��y}\u001bt^�|q����\u000f����GG�����m����͝w���z�1��_~z�����͋��?���O�f�]|�����\u001fn�����?��;=�^|�2�<\b�����\u0004i�?���������\\{�p��ۇ�/o\u001en�xq������_��w���|����8R\u001f��o>\u0005��%���d��{�՟�7�W����:�ɼg�����対\u0018d|�M����7_,�\u0017��o6����>���{`�/�_,�[��B���M��IJ�?�w/�����\u000e/�Hx�:|q8{@?��\u001c_,\u0016������&��������M�|r\u000f���w�Wo����\u000f�z\u0017^˾��+q\u0016��H~\\l<�ٖ��\u0017��yf��S=^,�X\f\u001e���String. Required.
\nYour API token.
\n"},{"key":"report_id","value":"4960","type":"text","description":"Integer. Required.
\nThe report ID. The maximum length is 2147483647 digits, minimum - 1.
\nDepending on the report type, use one of the report exporting methods to get the report ID. For example, exportAgentHistoryReport, exportQueueHistoryReport, exportTagsReport, exportCampaignReport, exportAgentCampaignReport, exportAgentCampaignAttemptsReport, etc.
\n"}]},"url":"https://{{host}}/api/v3/report/getReportStatus?domain={{domain}}","description":"Gets the information on the report processing status.
\nIf the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","getReportStatus"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"119ac50f-5b5c-41bc-b959-0f86c1f2de38","name":"getReportStatus","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"report_id","value":"4960","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/getReportStatus?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","getReportStatus"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 10:01:46 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c1b1cb6d513ca306284a6a96ccf5ebbd"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"processed\": true,\n \"report_id\": 4960\n }\n}"}],"_postman_id":"bcb0a354-4eca-4b81-b7a4-665cf904a869"},{"name":"exportQueueHistoryReport","id":"91a492ef-a446-4762-9fdf-717258cfefb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"csv","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"queue_ids","value":"[12]","type":"text","description":"JSON array. Optional.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues. By default, the report includes all queues.
\n","disabled":true},{"key":"date_from","value":"2022-09-24 00:00:00","type":"text","description":"String. Optional.
\nThe report start date. By default, the report is generated for the last hour before date_to. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"date_to","value":"2022-09-30 23:59:59","type":"text","description":"String. Optional.
\nThe report end date. By default, the end date is the current date and time. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"interval","value":"day","type":"text","description":"String. Required.
\nThe period selected in the date_from and date_to parameters is split into intervals, and the system generates the report by these intervals. The options are hour|day|week|month|all.
\nIf you specify 'all' in this parameter, the system generates the report for the whole period between date_from and date_to.
\n"}]},"url":"https://{{host}}/api/v3/report/exportQueueHistoryReport?domain={{domain}}","description":"Generates a queue report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportQueueHistoryReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"bd8f8ee0-5208-4735-a473-1dd9558ddcba","name":"exportQueueHistoryReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"csv","type":"text"},{"key":"queue_ids","value":"[12]","type":"text","disabled":true},{"key":"date_from","value":"2022-09-24 00:00:00","type":"text"},{"key":"date_to","value":"2022-09-30 23:59:59","type":"text"},{"key":"interval","value":"day","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/exportQueueHistoryReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportQueueHistoryReport"],"query":[{"key":"domain","value":"{{domain}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 10:01:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"867e234e29266eb556200b6676742d4a"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 4960\n }\n}"}],"_postman_id":"91a492ef-a446-4762-9fdf-717258cfefb2"},{"name":"exportTagsReport","id":"b66b4899-5469-4549-a795-65a58ca57e87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"locale","value":"en","type":"text","description":"String. Optional.
\nThe report language. The available options are ru|en. The default setting is en.
\n"},{"key":"date_from","value":"2022-09-24 00:00:00","type":"text","description":"String. Optional.
\nThe report start date. By default, the report is generated for the last hour before date_to. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"date_to","value":"2022-09-30 23:59:59","type":"text","description":"String. Optional.
\nThe report end date. By default, the end date is the current date and time. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"interval","value":"day","type":"text","description":"String. Required.
\nThe period selected in the date_from and date_to parameters is split into intervals, and the system generates the report by these intervals. The options are hour|day|week|month|all.
\nIf you specify 'all' in this parameter, the system generates the report for the whole period between date_from and date_to.
\n"},{"key":"queue_ids","value":"[1]","type":"text","description":"JSON array. Optional.
\nThe queue IDs to include in the report. Use the searchQueues method to retrieve the list of available queues.
\n"},{"key":"call_type","value":"incoming","type":"text","description":"String. Optional.
\nThe call direction. The options are incoming|outgoing.
\n"},{"key":"channel_ids","value":"[1]","type":"text","description":"JSON array. Optional.
\nThe channel IDs to include in the report.
\n"},{"key":"customer_ids","value":"[1]","type":"text","description":"JSON array. Optional.
\nThe customer IDs to include in the report.
\n"},{"key":"conversation_type","value":"messaging","type":"text","description":"String. Optional.
\nThe type of conversations to include in the report. The options are messaging|calls.
\n"},{"key":"tag_ids","value":"[1]","type":"text","description":"JSON array. Optional.
\nThe tag IDs to include in the report. Use the searchTags method to retrieve the list of available tags.
\n"},{"key":"user_ids","value":"[1]","description":"JSON array. Optional.
\nThe user IDs to include in the report. Use the searchUsers method to retrieve the list of user IDs.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/report/exportTagsReport?domain={{domain}}","description":"Generates a tag report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportTagsReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"75ac5c38-f358-41c3-ae02-1687f1176a28","name":"exportTagsReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"xlsx","type":"text"},{"key":"locale","value":"en","type":"text"},{"key":"date_from","value":"2022-09-24 00:00:00","type":"text"},{"key":"date_to","value":"2022-09-30 23:59:59","type":"text"},{"key":"interval","value":"day","type":"text"},{"key":"queue_ids","value":"[1]","type":"text"},{"key":"call_type","value":"incoming","type":"text"},{"key":"channel_ids","value":"[1]","type":"text"},{"key":"customer_ids","value":"[1]","type":"text"},{"key":"conversation_type","value":"messaging","type":"text"},{"key":"tag_ids","value":"[1]","type":"text"},{"key":"user_ids","value":"[1]","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/exportTagsReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportTagsReport"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 10:40:10 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"26d57c1521c86ba987819ada662fddc2"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 4961\n }\n}"}],"_postman_id":"b66b4899-5469-4549-a795-65a58ca57e87"},{"name":"exportCampaignReport","id":"3e67a25d-6450-4c8f-8287-86fceedc552e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"campaign_id","value":"363","type":"text","description":"Integer. Required.
\nThe automated campaign ID to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. The maximum length is 2147483647 digits, minimum - 1.
\n"}]},"url":"https://{{host}}/api/v3/report/exportCampaignReport?domain={{domain}}","description":"Generates an automated campaign report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportCampaignReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"cca49881-3ea3-43ac-a88f-8d778fdd0c1e","name":"exportCampaignReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"xlsx","type":"text"},{"key":"campaign_id","value":"363","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/exportCampaignReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportCampaignReport"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 10:45:51 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"e85f793b5a6617bda7cbf50597b4a44c"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"1"},{"key":"X-Rate-Limit-Remaining","value":"0"},{"key":"X-Rate-Limit-Reset","value":"1"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 4962\n }\n}"}],"_postman_id":"3e67a25d-6450-4c8f-8287-86fceedc552e"},{"name":"exportDncList","id":"2db23c57-42b9-47bd-92b4-a20104099457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"csv","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"id","value":"436","type":"text","description":"Integer. Required.
\nThe DNC list ID. The maximum length is 2147483647 digits, minimum - 1.
\n"},{"key":"locale","value":"en","type":"text","description":"String. Optional.
\nThe DNC list language. The available options are ru|en. The default setting is en.
\n"},{"key":"number","value":"","type":"text","description":"String. Optional.
\nThe particular phone number to include in the report.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/report/exportDncList?domain={{domain}}","description":"Exports a DNC list. The request returns the exported list ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportDncList"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"6af2da19-90f8-441a-9ca7-4c28e5656e9a","name":"exportDncList","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"csv","type":"text"},{"key":"id","value":"436","type":"text"},{"key":"locale","value":"en","type":"text"},{"key":"number","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/report/exportDncList?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportDncList"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 29 May 2023 08:33:34 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c36777988d26e4247d524c7fa79c491a"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 5143\n }\n}"}],"_postman_id":"2db23c57-42b9-47bd-92b4-a20104099457"},{"name":"exportAgentCampaignReport","id":"4608a127-88d4-4ef4-8755-7031e900dd94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"campaign_id","value":"1605","type":"text","description":"Integer. Required.
\nThe PDS campaign ID to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. The maximum length is 2147483647 digits, minimum - 1.
\n"},{"key":"locale","value":"en","description":"String. Optional.
\nThe report language. The available options are ru|en. The default setting is en.
\n","type":"text"},{"key":"campaign_list_id","value":"[1]","description":"JSON array. Optional.
\nThe campaign contact list IDs to include in the report.
\n","type":"text"},{"key":"status","value":"[\"ongoing\"]","type":"text","description":"JSON string array. Optional.
\nThe campaign statuses to include in the report. The options are ongoing|success|failed|canceled.
\n"},{"key":"phone","value":"123","type":"text","description":"String. Optional.
\nThe particular phone number to include in the report.
\n"},{"key":"from","value":"2021-10-11 00:00:00","type":"text","description":"String. Optional.
\nThe report start date. By default, the report is generated for the last hour before date_to. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"to","value":"2021-11-11 00:00:00","type":"text","description":"String. Optional.
\nThe report end date. By default, the end date is the current date and time. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"}]},"url":"https://{{host}}/api/v3/report/exportAgentCampaignReport?domain={{domain}}","description":"Generates a PDS campaign report. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportAgentCampaignReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"642d71c7-9775-452f-bb88-3fcb6616c6c2","name":"exportAgentCampaignReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"xlsx","type":"text"},{"key":"campaign_id","value":"2759","type":"text"},{"key":"locale","value":"en","type":"text"},{"key":"campaign_list_id","value":"[1]","type":"text"},{"key":"status","value":"[\"ongoing\"]","type":"text"},{"key":"phone","value":"123","type":"text"},{"key":"from","value":"2021-10-11 00:00:00","type":"text"},{"key":"to","value":"2021-11-11 00:00:00","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/report/exportAgentCampaignReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportAgentCampaignReport"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 12:37:26 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"83c857034ec0aa450edb6628d174246d"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 4963\n }\n}"}],"_postman_id":"4608a127-88d4-4ef4-8755-7031e900dd94"},{"name":"exportAgentCampaignAttemptsReport","id":"11103c88-f17b-413a-92a4-608697946630","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"format","value":"xlsx","type":"text","description":"String. Optional.
\nThe report format. The supported formats are xlsx and csv, the default option is xlsx.
\n"},{"key":"agent_campaign_id","value":"2759","type":"text","description":"Integer. Required.
\nThe PDS campaign ID to include in the report. Use the searchCampaigns method to retrieve the list of available campaigns. The maximum length is 2147483647 digits, minimum - 1.
\n"},{"key":"locale","value":"en","type":"text","description":"String. Optional.
\nThe report language. The available options are ru|en. The default setting is en.
\n"},{"key":"campaign_list_id","value":"[1]","type":"text","description":"JSON array. Optional.
\nThe campaign contact list IDs to include in the report.
\n"},{"key":"status","value":"[\"ongoing\"]","type":"text","description":"JSON string array. Optional.
\nThe campaign statuses to include in the report. The options are ongoing|success|failed|canceled.
\n"},{"key":"phone","value":"123","type":"text","description":"String. Optional.
\nThe particular phone number to include in the report.
\n","disabled":true},{"key":"from","value":"2021-10-11 00:00:00","type":"text","description":"String. Optional.
\nThe report start date. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"},{"key":"to","value":"2021-11-11 00:00:00","type":"text","description":"String. Optional.
\nThe report end date. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00.
\n"}]},"url":"https://{{host}}/api/v3/report/exportAgentCampaignAttemptsReport?domain={{domain}}","description":"Generates a report on PDS campaign attempts. The request returns the report ID.
\nUse the getReportStatus method to check whether the report is processed. If the response parameter \"processed\" is true, you can download the report via the downloadReport method.
\n","urlObject":{"protocol":"https","path":["api","v3","report","exportAgentCampaignAttemptsReport"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"d0d18102-92e8-4e04-a89e-adf95956e1b2","name":"exportAgentCampaignAttemptsReport","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"format","value":"xlsx","type":"text"},{"key":"agent_campaign_id","value":"2759","type":"text"},{"key":"locale","value":"en","type":"text"},{"key":"campaign_list_id","value":"[1]","type":"text"},{"key":"status","value":"[\"ongoing\"]","type":"text"},{"key":"phone","value":"123","type":"text","disabled":true},{"key":"from","value":"2021-10-11 00:00:00","type":"text","description":"String. Optional.\n\nThe report start date. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00."},{"key":"to","value":"2021-11-11 00:00:00","type":"text","description":"String. Optional.\n\nThe report end date. The format is YYYY-MM-DD HH:mm:ss. Example: 2022-11-01 00:00:00."}]},"url":{"raw":"https://{{host}}/api/v3/report/exportAgentCampaignAttemptsReport?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","report","exportAgentCampaignAttemptsReport"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 16 May 2023 12:42:10 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"738fe1fdba05e65db3c5489748883f80"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"10"},{"key":"X-Rate-Limit-Remaining","value":"9"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"report_id\": 4964\n }\n}"}],"_postman_id":"11103c88-f17b-413a-92a4-608697946630"}],"id":"d864e5c8-4828-4142-88b5-d97857ea9501","description":"The folder contains actions you may need to manage various reports (agent, queue, tag, PDS, and automated campaign reports).
\n","_postman_id":"d864e5c8-4828-4142-88b5-d97857ea9501"},{"name":"scenario","item":[{"name":"runScenario","id":"845c6216-07fc-4cc2-8832-06d37b842eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"scenario_id","value":"2066","type":"text","description":"Integer. Required.
\nThe scenario ID. Use the searchScenarios method to retrieve the list of scenarios available on the account.
\n"},{"key":"phone","value":"17472120732","type":"text","description":"Integer. Required.
\nThe callee phone number.
\n"},{"key":"variables","value":"{\"UTC\":\"America/Araguaina\"}","type":"text","description":"JSON. Optional.
\nThe variables and their values in JSON format to use in the scenario: {\"custom_field_1\": \"custom_value_1\", \"custom_field_2\": \"custom_value_2\", …}.
\n"},{"key":"phone_number_id","value":"268","type":"text","description":"Integer. Required if caller_id and sip_number_is are empty.
\nThe phone number ID. This is the ID of the phone number you purchased in Voximplant Kit. Use the searchNumbers method to retrieve available phone numbers.
\n"},{"key":"caller_id","value":"","type":"text","description":"Integer. Required if phone_number_id and sip_number_id are empty.
\nThe Caller ID identifier. This is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"callerid","value":"","description":"Integer. Optional.
\nThe scenario phone number. It can be either a custom Caller ID or a purchased phone number. Example: 17471234567.
\n","type":"text","disabled":true},{"key":"sip_number_id","value":"285","type":"text","description":"Integer. Required if caller_id and phone_number_id are empty.
\nThe SIP number identifier. Use the searchSipNumber method to retrieve available SIP number IDs.
\n","disabled":true},{"key":"","value":"","type":"text","uuid":"d271427b-302e-440b-940f-e20a6d20a32a","disabled":true}]},"url":"https://{{host}}/api/v3/scenario/runScenario?domain={{domain}}","description":"Runs a scenario.
\n","urlObject":{"protocol":"https","path":["api","v3","scenario","runScenario"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"cf792e65-bf33-4ed5-8bfa-1a5496e78e34","name":"runScenario","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"scenario_id","value":"2066","type":"text","description":"Integer. Required.\n\nThe scenario ID. Use the searchScenarios method to retrieve the list of scenarios available on the account."},{"key":"phone","value":"17472120732","type":"text","description":"Integer. Required.\n\nThe callee phone number."},{"key":"variables","value":"{\"UTC\":\"America/Araguaina\"}","type":"text","description":"JSON. Optional.\n\nThe variables and their values in JSON format to be used in the scenario. {\"custom_field_1\": \"custom_value_1\", \"custom_field_2\": \"custom_value_2\", …}"},{"key":"phone_number_id","value":"268","type":"text","description":"Integer. Required if caller_id is empty.\n\nThe phone number ID. This is the ID of the phone number you purchased in Voximplant Kit. Use the searchNumbers method to retrieve available phone numbers.\n"},{"key":"caller_id","value":"","type":"text","description":"Integer. Required if phone_number_id is empty.\n\nThe Caller ID identifier. This is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.\n","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/scenario/runScenario?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","scenario","runScenario"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 29 May 2023 08:49:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"845c6216-07fc-4cc2-8832-06d37b842eb8"},{"name":"searchScenarios","id":"7d11289c-99c2-4cc3-bba3-8de3e42493b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"","type":"text","description":"String. Optional.
\nThe particular scenario title to filter.
\n","disabled":true},{"key":"scenario_type","value":"1","type":"text","description":"Integer. Optional.
\nThe scenario type. The options are 1 (outbound) and 2 (inbound).
\n","disabled":true},{"key":"scenario_id","value":"4415","type":"text","description":"Integer. Optional.
\nThe particular scenario ID to filter.
\n"}]},"url":"https://{{host}}/api/v3/scenario/searchScenarios?domain={{domain}}&sort=-id","description":"Retrieves a list of scenarios available on the account.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","scenario","searchScenarios"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-id"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":""}],"variable":[]}},"response":[{"id":"ee2e5f85-201a-440f-b74f-0803b7f26d71","name":"searchScenarios","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"title","value":"","type":"text","disabled":true},{"key":"scenario_type","value":"1","type":"text","disabled":true},{"key":"shared","value":"false","type":"text","disabled":true},{"key":"scenario_id","value":"4415","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/scenario/searchScenarios?domain={{domain}}&sort=-id","protocol":"https","host":["{{host}}"],"path":["api","v3","scenario","searchScenarios"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."},{"key":"sort","value":"-id"},{"key":"page","value":"1","type":"text","description":"Integer. Optional.\n\nThe number of pages per report.","disabled":true},{"key":"per-page","value":"","type":"text","description":"Integer. Optional.\n\nThe number of records per page.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 13:28:28 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"3eb5ac8ecd5996207db17476d34eb996"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"3979","type":"text","description":"Integer. Required.
\nThe scenario ID. Use the searchScenarios method to retrieve the list of scenarios available on the account.
\n"},{"key":"required_only","value":"1","description":"Boolean. Optional.
\nSpecifies whether the request should return only variables required to run the scenario ({{phone}} and {{UTC}}). The options are 1 (required) and 0 (not required). The default value is 0.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/scenario/getScenarioVariables?domain={{domain}}","description":"Gets scenario variables.
\n","urlObject":{"protocol":"https","path":["api","v3","scenario","getScenarioVariables"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"0c6608db-ecf1-4948-aa3d-71977d798688","name":"getScenarioVariables","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"3979","type":"text"},{"key":"required_only","value":"1","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/scenario/getScenarioVariables?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","scenario","getScenarioVariables"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 13:59:35 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"afd17e4fb95ae026b3e83ef39d493d5d"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n \"UTC\",\n \"phone\"\n ]\n}"}],"_postman_id":"2b8a5e3d-7f35-4058-ab35-1af249910871"},{"name":"getSipUri","id":"28072580-7301-4c20-bb30-1887fab37d3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"scenario_id","type":"text","value":"3697","description":"Integer. Required.
\nThe scenario ID. Use the searchScenarios method to retrieve the list of scenarios available on the account.
\n"}]},"url":"https://{{host}}/api/v2/scenario/getSipUri?domain={{domain}}","description":"Gets the scenario SIP URI.
\n","urlObject":{"protocol":"https","path":["api","v2","scenario","getSipUri"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"a019f39a-1c14-4020-b09d-90a8f9e90369","name":"getSipUri","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"scenario_id","value":"3697","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/scenario/getSipUri?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","scenario","getSipUri"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 14:22:17 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"7d190d09a5ca53c87579aeb135cc1736"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": \"scenario_3697@forward.voximplant.com\"\n}"}],"_postman_id":"28072580-7301-4c20-bb30-1887fab37d3b"}],"id":"9564af21-fdfa-4617-bcd6-e4cb1a66ebab","description":"This folder contains actions you may need to manage scenarios in the account.
\nA scenario is a flow diagram that determines the logic of processing inbound and outbound calls.
\n","_postman_id":"9564af21-fdfa-4617-bcd6-e4cb1a66ebab"},{"name":"sipNumber","item":[{"name":"createSipNumber","id":"69c3a2f9-cc16-4565-a6e9-07da383e2a99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"sip_trunk_id","value":"280","description":"Integer. Required.
\nThe SIP trunk ID. Use the searchSipTrunk method to retrieve the list of available SIP trunks.
\n"},{"type":"text","key":"number","value":"1740200600","description":"String. Required.
\nThe SIP number of an external user (the number in SIP URI before host).
\n"},{"type":"text","key":"name","value":"for international communication","description":"String. Optional.
\nThe external number description.
\n"}]},"url":"https://{{host}}/api/v3/sipNumber/createSipNumber?domain={{domain}}","description":"Adds an external number.
\n","urlObject":{"protocol":"https","path":["api","v3","sipNumber","createSipNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"c8b6e828-b135-42e6-a3a3-11ff5397a810","name":"createSipNumber","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.\n\nYour API token."},{"type":"text","key":"sip_trunk_id","value":"280","description":"Integer. Required.\n\nThe SIP trunk ID. Use the searchSipTrunk method to retrieve the list of available SIP trunks."},{"type":"text","key":"number","value":"1740200600","description":"String. Required.\n\nThe SIP number of an external user (the number in SIP URI before host)."},{"type":"text","key":"name","value":"for international communication","description":"String. Optional.\n\nThe external number description."}]},"url":{"raw":"https://{{host}}/api/v3/sipNumber/createSipNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipNumber","createSipNumber"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:06:08 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"13a9ef3c2f1d74712b91b7dbb922b7f1"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 166,\n \"sip_trunk_id\": 280,\n \"name\": \"for international communication\",\n \"number\": \"1740200600\",\n \"create_date\": \"2023-06-19 10:06:08\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null\n }\n}"}],"_postman_id":"69c3a2f9-cc16-4565-a6e9-07da383e2a99"},{"name":"updateSipNumber","id":"c8600c47-022c-4259-b9f1-3b49a1fdfd0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"id","value":"166","description":"Integer. Required.
\nThe external number ID. Use the searchSipNumber method to retrieve the list of available external numbers.
\n"},{"type":"text","key":"sip_trunk_id","value":"280","description":"Integer. Optional.
\nThe SIP trunk ID associated with the external number. Use the searchSipTrunk method to retrieve the list of available SIP trunks.
\n"},{"type":"text","key":"number","value":"1740200600","description":"String. Optional.
\nThe SIP number of an external user (the number in SIP URI before host).
\n"},{"type":"text","key":"name","value":"business","description":"String. Optional.
\nThe external number description.
\n"}]},"url":"https://{{host}}/api/v3/sipNumber/updateSipNumber?domain={{domain}}","description":"Updates an external number.
\n","urlObject":{"protocol":"https","path":["api","v3","sipNumber","updateSipNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"2578695b-3b0c-4bd0-8473-e78dffac6db7","name":"updateSipNumber","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.\n\nYour API token."},{"type":"text","key":"id","value":"166","description":"Integer. Required.\n\nThe external number ID. Use the searchSipNumber method to retrieve the list of available external numbers."},{"type":"text","key":"sip_trunk_id","value":"280","description":"Integer. Optional.\n\nThe SIP trunk ID associated with the external number. Use the searchSipTrunk method to retrieve the list of available SIP trunks."},{"type":"text","key":"number","value":"1740200600","description":"String. Optional.\n\nThe SIP number of an external user (the number in SIP URI before host)."},{"type":"text","key":"name","value":"business","description":"String. Optional.\n\nThe external number description."}]},"url":{"raw":"https://{{host}}/api/v3/sipNumber/updateSipNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipNumber","updateSipNumber"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:06:57 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4909470fd4530d1549dccc425cc8cced"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 166,\n \"sip_trunk_id\": 280,\n \"name\": \"business\",\n \"number\": \"1740200600\",\n \"create_date\": \"2023-06-19 10:06:08\",\n \"created_by\": 1721,\n \"edit_date\": \"2023-06-19 10:06:57\",\n \"edited_by\": 1721\n }\n}"}],"_postman_id":"c8600c47-022c-4259-b9f1-3b49a1fdfd0a"},{"name":"deleteSipNumber","id":"4bcc7c93-bab2-4058-b521-2bc3b845414b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"type":"text","key":"id","value":"166","description":"Integer. Required.
\nThe external number ID. Use the searchSipNumber method to retrieve the list of available external numbers.
\n"}]},"url":"https://{{host}}/api/v3/sipNumber/deleteSipNumber?domain={{domain}}","description":"Deletes an external number.
\n","urlObject":{"protocol":"https","path":["api","v3","sipNumber","deleteSipNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"b5b95f0b-f392-42f7-bab5-f7f33f3ea76a","name":"deleteSipNumber","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.\n\nYour API token."},{"type":"text","key":"id","value":"8","description":"Integer. Required.\n\nThe external number ID. Use the searchSipNumber method to retrieve the list of available external numbers."}]},"url":{"raw":"https://{{host}}/api/v3/sipNumber/deleteSipNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipNumber","deleteSipNumber"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:07:15 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"49c2057fc79c39138f6a5f0bffa4dd79"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"4bcc7c93-bab2-4058-b521-2bc3b845414b"},{"name":"searchSipNumber","id":"a2101773-52d5-4420-838b-bda2a1456494","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"8","type":"text","description":"Integer. Optional.
\nThe particular external number ID to filter.
\n","disabled":true},{"key":"number","value":"","type":"text","description":"String. Optional.
\nThe particular SIP number to filter.
\n","disabled":true},{"key":"sip_trunk_id","value":"132","type":"text","description":"Integer. Optional.
\nThe particular SIP trunk ID to filter. Use the searchSipTrunk method to retrieve the list of available SIP trunks.
\n","disabled":true},{"type":"text","key":"name","value":"test name","description":"String. Optional.
\n","disabled":true},{"key":"keyword","value":"test","description":"String. Optional.
\nAny keyword to filter (description or number).
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/sipNumber/searchSipNumber?domain={{domain}}","description":"Retrieves a list of external numbers.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","sipNumber","searchSipNumber"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"3acb5b15-6c64-44e0-9ef1-9d5dddb83584","name":"searchSipNumber","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"id","value":"8","type":"text","description":"Integer. Optional.\n\nThe particular external number ID to filter.","disabled":true},{"key":"number","value":"8800200600","type":"text","description":"String. Optional.\n\nThe particular SIP number to filter.","disabled":true},{"key":"sip_trunk_id","value":"132","type":"text","description":"Integer. Optional.\n\nThe particular SIP trunk ID to filter. Use the searchSipTrunk method to retrieve the list of available SIP trunks.","disabled":true},{"key":"keyword","value":"test","description":"String. Optional.\n\nAny keyword to filter (description or number).","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/sipNumber/searchSipNumber?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipNumber","searchSipNumber"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 12:18:29 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"0d61b3c3e6303ef3a753db9b6d1d02d1"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"The folder contains actions you may need to manage external numbers.
\nAn external number is a phone number you add and associate with a SIP trunk. After adding an external number you can select it as a Caller ID for outbound SIP calls anywhere in Voximplant Kit: automated and PDS campaigns, outbound scenarios, and softphone.
\n","_postman_id":"058149a4-550f-4bec-81c8-88f570abc38c"},{"name":"sipTrunk","item":[{"name":"searchSipTrunk","id":"db7dd928-6d4b-48b7-951c-f5729e60e2d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"43","type":"text","description":"Integer. Optional.
\nThe particular SIP trunk ID to filter.
\n"},{"key":"title","value":"PBX 25","description":"String. Optional.
\nThe particular SIP trunk title to filter. The request returns full and partial matches.
\n","type":"text"},{"key":"with_remote_extensions\n","value":"","description":"Array. Optional.
\nThe remote extensions to include in the report.
\n","type":"text","disabled":true},{"key":"with_sip_numbers","value":"","description":"Array. Optional.
\nThe SIP numbers to include in the report. A SIP number is an external number you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available SIP numbers.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/sipTrunk/searchSipTrunk?domain={{domain}}","description":"Retrieves a list of available SIP trunks.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","sipTrunk","searchSipTrunk"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"edit_date"}],"variable":[]}},"response":[{"id":"12e9a7d5-b997-4baa-9679-69810ee379da","name":"searchSipTrunk","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"43","type":"text"},{"key":"title","value":"PBX 25","type":"text","disabled":true},{"key":"sort","value":"edit_date","type":"text","disabled":true},{"key":"with_remote_extensions","value":"","type":"text","disabled":true},{"key":"with_sip_numbers","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/sipTrunk/searchSipTrunk?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipTrunk","searchSipTrunk"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 10:27:42 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"7c959e3b94fb4ed5caef1c09fb0b3f05"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"PBX 27","description":"String. Required.
\nThe SIP trunk name.
\n","type":"text"},{"key":"peer_address","value":"192.168.2.1","description":"String. Required.
\nThe domain of the SIP proxy.
\n","type":"text"},{"key":"transport","value":"TLS","description":"String. Required.
\nThe SIP transport protocol. The options are 'UDP', 'TCP', and 'TLS'.
\n","type":"text"},{"key":"auth_user","value":"user","description":"String. Optional.
\nThe provider's username for SIP authentication.
\n","type":"text"},{"key":"password","value":"pass","description":"String. Optional.
\nThe provider's password for SIP authentication.
\n","type":"text"},{"key":"prefix","value":"pref","description":"String. Optional.
\nThe phone number prefix.
\n","type":"text"},{"key":"out_proxy","value":"prox","description":"String. Optional.
\nThe outbound proxy.
\n","type":"text"},{"key":"change_caller_id","value":"false","description":"Boolean. Optional.
\nSpecifies whether you can replace the Caller ID set by the user for an outbound call with the default Caller ID for this SIP trunk. The default setting is false.
\n","type":"text"},{"key":"caller_id","value":"","description":"String. Required when change_caller_id is true.
\nThe default Caller ID for the SIP trunk.
\n","type":"text","disabled":true},{"key":"change_caller_id_domain","value":"false","description":"Boolean. Optional.
\nSpecifies whether you can set the domain in the From field. The default setting is false.
\n","type":"text"},{"key":"caller_id_domain","value":"","description":"String. Required when change_caller_id_domain is true.
\nThe domain for outbound calls.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/sipTrunk/createSipTrunk?domain={{domain}}","description":"Creates a SIP trunk.
\n","urlObject":{"protocol":"https","path":["api","v3","sipTrunk","createSipTrunk"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"3b179af3-b2b3-4f82-b995-58fce6104fb8","name":"createSipTrunk","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"title","value":"PBX 27","type":"text"},{"key":"peer_address","value":"test_address","type":"text"},{"key":"transport","value":"TLS","type":"text"},{"key":"auth_user","value":"user","type":"text"},{"key":"password","value":"pass","type":"text"},{"key":"prefix","value":"pref","type":"text"},{"key":"out_proxy","value":"prox","type":"text"},{"key":"change_caller_id","value":"false","type":"text"},{"key":"caller_id","value":"","type":"text","disabled":true},{"key":"change_caller_id_domain","value":"false","type":"text"},{"key":"caller_id_domain","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/sipTrunk/createSipTrunk?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipTrunk","createSipTrunk"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 09:55:54 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"837302bb36d639319e0168b95266211a"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"peer_address\": \"192.168.2.1\",\n \"transport\": \"TLS\",\n \"auth_user\": \"user\",\n \"password\": \"pass\",\n \"prefix\": \"pref\",\n \"out_proxy\": \"prox\",\n \"change_caller_id\": false,\n \"caller_id\": null,\n \"change_caller_id_domain\": false,\n \"caller_id_domain\": null,\n \"id\": 279,\n \"title\": \"PBX 27\",\n \"create_date\": \"2023-06-19 09:55:54\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"deleted\": false\n }\n}"}],"_postman_id":"2bbd05e7-0662-44e4-b5a7-3b19cbec4004"},{"name":"updateSipTrunk","id":"9dc3ed23-fb2b-48da-a9b9-f71d5c83b8ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"279","description":"Integer. Required.
\nThe SIP trunk ID. Use the searchSipTrunk method to retrieve the list of available SIP trunks.
\n","type":"text"},{"key":"title","value":"PBX 27","description":"String. Optional.
\nThe SIP trunk name.
\n","type":"text"},{"key":"peer_address","value":"192.212.2.1","description":"String. Optional.
\nThe domain of the SIP proxy.
\n","type":"text"},{"key":"transport","value":"TCP","description":"String. Optional.
\nThe SIP transport protocol. The options are 'UDP', 'TCP', and 'TLS'.
\n","type":"text","disabled":true},{"key":"auth_user","value":"","description":"String. Optional.
\nThe provider's username for SIP authentication.
\n","type":"text","disabled":true},{"key":"password","value":"","description":"String. Optional.
\nThe provider's password for SIP authentication.
\n","type":"text","disabled":true},{"key":"prefix","value":"","description":"String. Optional.
\nThe phone number prefix.
\n","type":"text","disabled":true},{"key":"out_proxy","value":"","description":"String. Optional.
\nThe outbound proxy.
\n","type":"text","disabled":true},{"key":"change_caller_id","value":"false","description":"Boolean. Optional.
\nSpecifies whether you can replace the Caller ID set by the user for an outbound call with the default Caller ID for this SIP trunk. The default setting is false.
\n","type":"text"},{"key":"caller_id","value":"","description":"String. Required when change_caller_id is true.
\nThe default Caller ID for the SIP trunk.
\n","type":"text","disabled":true},{"key":"change_caller_id_domain","value":"false","description":"Boolean. Optional.
\nSpecifies whether you can set the domain in the From field. The default setting is false.
\n","type":"text"},{"key":"caller_id_domain","value":"","description":"String. Required when change_caller_id_domain is true.
\nThe domain for outbound calls.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/sipTrunk/updateSipTrunk?domain={{domain}}","description":"Updates a SIP trunk.
\n","urlObject":{"protocol":"https","path":["api","v3","sipTrunk","updateSipTrunk"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"23d822d2-7d4a-4782-b1c8-cdec02b53808","name":"updateSipTrunk","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"279","type":"text"},{"key":"title","value":"PBX 27","type":"text"},{"key":"peer_address","value":"192.212.2.1","type":"text"},{"key":"transport","value":"TCP","type":"text","disabled":true},{"key":"auth_user","value":"","type":"text","disabled":true},{"key":"password","value":"","type":"text","disabled":true},{"key":"prefix","value":"","type":"text","disabled":true},{"key":"out_proxy","value":"","type":"text","disabled":true},{"key":"change_caller_id","value":"false","type":"text"},{"key":"caller_id","value":"","type":"text","disabled":true},{"key":"change_caller_id_domain","value":"false","type":"text"},{"key":"caller_id_domain","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/sipTrunk/updateSipTrunk?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipTrunk","updateSipTrunk"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:00:07 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"05a4077eea3bbe07f8fe8f217162ceb9"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"peer_address\": \"192.212.2.1\",\n \"transport\": \"TLS\",\n \"auth_user\": \"user\",\n \"password\": \"pass\",\n \"prefix\": \"pref\",\n \"out_proxy\": \"prox\",\n \"change_caller_id\": false,\n \"caller_id\": null,\n \"change_caller_id_domain\": false,\n \"caller_id_domain\": null,\n \"id\": 279,\n \"title\": \"PBX 27\",\n \"create_date\": \"2023-06-19 09:55:54\",\n \"created_by\": 1721,\n \"edit_date\": \"2023-06-19 10:00:07\",\n \"edited_by\": 1721,\n \"delete_date\": null,\n \"deleted_by\": null,\n \"deleted\": false\n }\n}"}],"_postman_id":"9dc3ed23-fb2b-48da-a9b9-f71d5c83b8ac"},{"name":"deleteSipTrunk","id":"358fad8f-2367-45bb-bbdb-47c315ff9ff0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"279","description":"Integer. Required.
\nThe SIP trunk ID. Use the searchSipTrunk method to retrieve the list of available SIP trunks.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/sipTrunk/deleteSipTrunk?domain={{domain}}","description":"Deletes a SIP trunk.
\n","urlObject":{"protocol":"https","path":["api","v3","sipTrunk","deleteSipTrunk"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"ba6ae0c8-7f31-4078-a11a-876b5fb970be","name":"deleteSipTrunk","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"279","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/sipTrunk/deleteSipTrunk?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipTrunk","deleteSipTrunk"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:00:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"036f35e3649094649bd2b83ff2cd6c9e"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"358fad8f-2367-45bb-bbdb-47c315ff9ff0"},{"name":"searchRemoteExtension","id":"aa28554e-46b7-426f-b1d5-87b6455351c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"type":"text","key":"access_token","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"sip_trunk_id","value":"1","description":"Integer. Optional.
\nThe particular SIP trunk ID to filter. Use the searchSipTrunk method to retrieve the list of available SIP trunks.
\n","type":"text","disabled":true},{"key":"id","value":"[7,6]","type":"text","description":"Integer or integer array. Optional.
\nThe particular remote extension IDs to filter. Example: [1,2].
\n","disabled":true},{"key":"name","value":"test","type":"text","description":"String. Optional.
\nThe particular remote extension name to filter.
\n","disabled":true},{"key":"with_extension","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include Voximplant Kit internal extensions. The default value is null.
\n","disabled":true},{"key":"with_sip_trunk","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report should include SIP trunks. The default value is null.
\n","disabled":true},{"key":"number_extension","value":"9909","description":"Integer. Optional.
\nThe particular internal extension number assigned to the remote extension.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/sipTrunk/searchRemoteExtension?domain={{domain}}","description":"Retrieves a list of available remote extensions.
\nA remote extension belongs to an external user who works in your remote PBX connected to the Kit contact center through a SIP trunk. After adding a remote extension, you can transfer calls to this number, as you do to internal Voximplant Kit extensions.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","sipTrunk","searchRemoteExtension"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"edit_date"}],"variable":[]}},"response":[{"id":"3986cc6a-df19-4652-aa23-a8a23ca7bec1","name":"searchRemoteExtension","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"sip_trunk_id","value":"1","type":"text","disabled":true},{"key":"id","value":"[7,6]","type":"text","disabled":true},{"key":"name","value":"test","type":"text","disabled":true},{"key":"with_extension","value":"true","type":"text","disabled":true},{"key":"with_sip_trunk","value":"true","type":"text","disabled":true},{"key":"sort","value":"edit_date","type":"text","disabled":true},{"key":"with_extension","value":"","type":"text","disabled":true},{"key":"with_sip_trunk","value":"","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/sipTrunk/searchRemoteExtension?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","sipTrunk","searchRemoteExtension"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 11:07:49 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"9084ff3c7a6d663879d7e12ed082e8e7"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"4"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"This folder contains actions you may need to manage SIP trunks.
\nA SIP trunk is a virtual communication channel that transports calls from one PBX to another.
\nWith the SIP trunking feature you can:
\nString. Required.
\nYour API token.
\n"},{"key":"sip_whitelist_network","value":"127.0.0.1","type":"text","description":"String. Required.
\nThe IP address you want to add to the SIP whitelist.
\n"}]},"url":"https://{{host}}/api/v2/sip/createSipWhitelist?domain={{domain}}","description":"Adds a new IP address to the SIP whitelist.
\n","urlObject":{"protocol":"https","path":["api","v2","sip","createSipWhitelist"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"67093e73-9dc8-474b-8294-0907482879b7","name":"createSipWhitelist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"sip_whitelist_network","value":"127.0.0.1","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/sip/createSipWhitelist?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","sip","createSipWhitelist"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 08:10:03 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"bc9a5679e5bd68a21c451b393696a7ed"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"0ac0c314-26d0-4109-a915-e3687fbf19fa"},{"name":"updateSipWhitelist","id":"7f17fe15-9066-4cf2-a9ba-31001f1afb65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"55","type":"text","description":"Integer. Required.
\nThe IP address ID. Use the searchSipWhitelist method to retrieve available whitelisted addresses.
\n"},{"key":"sip_whitelist_network","value":"13.224.80.102","type":"text","description":"String. Required.
\nThe IP address.
\n"}]},"url":"https://{{host}}/api/v2/sip/updateSipWhitelist?domain={{domain}}","description":"Edits an address from the SIP whitelist.
\n","urlObject":{"protocol":"https","path":["api","v2","sip","updateSipWhitelist"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"65e5e3f6-dfc3-4749-bf79-f4c44bfa606a","name":"updateSipWhitelist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"55","type":"text"},{"key":"sip_whitelist_network","value":"13.224.80.102","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/sip/updateSipWhitelist?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","sip","updateSipWhitelist"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 08:21:23 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"4256be14c0aca421734a631199ac0e17"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"7f17fe15-9066-4cf2-a9ba-31001f1afb65"},{"name":"deleteSipWhitelist","id":"7c6b1dde-4708-469a-82a5-74cc4a83e6b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","type":"text","value":"132","description":"Integer. Required.
\nThe IP address ID. Use the searchSipWhitelist method to retrieve available whitelisted addresses.
\n"}]},"url":"https://{{host}}/api/v2/sip/deleteSipWhitelist?domain={{domain}}","description":"Deletes an address from the SIP whitelist.
\n","urlObject":{"protocol":"https","path":["api","v2","sip","deleteSipWhitelist"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"a8284d4c-8941-4356-8ab1-3c4cf6e7eada","name":"deleteSipWhitelist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"132","type":"text"}]},"url":{"raw":"https://{{host}}/api/v2/sip/deleteSipWhitelist?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","sip","deleteSipWhitelist"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 08:28:58 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"810d31a05eebf4f73b9a20d6e7b306aa"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"7c6b1dde-4708-469a-82a5-74cc4a83e6b8"},{"name":"searchSipWhitelist","id":"10380590-9963-4aa8-b053-2da6d12c9690","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"132","type":"text","description":"Integer. Optional.
\nThe particular whitelisted IP address ID to filter.
\n","disabled":true},{"key":"sip_whitelist_network","value":"127.0.0.1","type":"text","description":"String. Optional.
\nThe particular whitelisted IP address to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v2/sip/searchSipWhitelist?domain={{domain}}","description":"Retrieves a list of IP addresses added to the SIP whitelist.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v2","sip","searchSipWhitelist"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"21e09579-881b-4cf7-9d8c-c2fe9b23aa03","name":"searchSipWhitelist","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"132","type":"text","disabled":true},{"key":"sip_whitelist_network","value":"127.0.0.1","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v2/sip/searchSipWhitelist?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v2","sip","searchSipWhitelist"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 08:20:58 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"754606291fef6806c55a9d47c7893542"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"3"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"The folder contains actions you may need to manage the SIP whitelist.
\nA SIP whitelist stores IP addresses that are allowed to initiate SIP calls to Voximplant Kit without SIP authorization.
\n","_postman_id":"785f9005-c57c-4c20-82f2-132389b4bbcb"},{"name":"skills","item":[{"name":"addSkill","id":"cfafe78b-b66d-48e6-b37d-78f101d06356","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"skill_name","value":"Knows Portuguese","type":"text","description":"String. Required.
\nThe skill name. The minimum length is 3 characters, the maximum is 100.
\n"},{"key":"description","value":"Native Brazilian","type":"text","description":"String. Optional.
\nThe skill description. The maximum length is 200 characters.
\n"}]},"url":"https://{{host}}/api/v3/skills/addSkill?domain={{domain}}","description":"Creates a skill. The request returns the skill ID.
\n","urlObject":{"protocol":"https","path":["api","v3","skills","addSkill"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"1bede5f7-a3dc-4b36-865d-b744b4f2cd35","name":"addSkill","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"skill_name","value":"Knows Portuguese","type":"text"},{"key":"description","value":"Native Brazilian","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/skills/addSkill?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","skills","addSkill"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 14:37:53 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"16edf508eec834f969c46114c9adb480"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 293\n }\n}"}],"_postman_id":"cfafe78b-b66d-48e6-b37d-78f101d06356"},{"name":"updateSkill","id":"7860740e-48c9-48eb-a86b-558b1d088b01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","type":"text","value":"{{access_token}}","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"293","type":"text","description":"Integer. Required.
\nThe skill ID. Use the searchSkills method to retrieve the list of available skills.
\n"},{"key":"skill_name","type":"text","value":"","description":"String. Optional.
\nThe skill name. The minimum length is 3 characters, the maximum is 100.
\n","disabled":true},{"key":"description","type":"text","value":"Native Brazilian, speaks Spanish and English","description":"String. Optional.
\nThe skill description. The maximum length is 200 characters.
\n"}]},"url":"https://{{host}}/api/v3/skills/updateSkill?domain={{domain}}","description":"Updates a skill.
\n","urlObject":{"protocol":"https","path":["api","v3","skills","updateSkill"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"7ba9824f-0542-409a-b83a-2ac9d5dd162a","name":"updateSkill","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"293","type":"text"},{"key":"skill_name","value":"","type":"text","disabled":true},{"key":"description","value":"Native Brazilian, speaks Spanish and English","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/skills/updateSkill?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","skills","updateSkill"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 14:48:11 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"312720eacc766852740355b696d4e7bc"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"7860740e-48c9-48eb-a86b-558b1d088b01"},{"name":"searchSkills","id":"f832bb52-0db1-4327-8851-83b4c03430a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"","type":"text","description":"Integer|JSON (integer array). Optional.
\nThe particular skill ID(s) to filter.
\n","disabled":true},{"key":"skill_name","value":"Knows Portuguese","description":"String. Optional.
\nThe particular skill name to filter. The minimum length is 3 characters, the maximum is length 100.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/skills/searchSkills?domain={{domain}}","description":"Retrieves a list of available skills.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","skills","searchSkills"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"bf5f7d17-7e44-460b-9280-68110517c795","name":"searchSkills","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"","type":"text","disabled":true},{"key":"skill_name","value":"Knows Portuguese","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/skills/searchSkills?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","skills","searchSkills"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 14:53:02 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"474600f9d639c7d4b862b59654324156"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"93","type":"text","description":"Integer. Required.
\nThe skill ID. Use the searchSkills method to retrieve the list of available skills.
\n"}]},"url":"https://{{host}}/api/v3/skills/deleteSkill?domain={{domain}}","description":"Deletes a skill.
\n","urlObject":{"protocol":"https","path":["api","v3","skills","deleteSkill"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"22c2657e-9826-4bcd-821c-436d40262411","name":"deleteSkill","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"id","value":"93","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/skills/deleteSkill?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","skills","deleteSkill"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 14:53:54 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"d87e5512cf4ec66338cb089d72f603c2"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"49214faa-824a-4010-b604-d6afb2076ebf"}],"id":"6eea41f5-8243-42b0-bdae-c195e00dc124","description":"Use this folder to manage user skills.
\nSkills allow users to share information about their professional expertise and help managers and supervisors distribute calls and chats between agents based on that.
\n","_postman_id":"6eea41f5-8243-42b0-bdae-c195e00dc124"},{"name":"tags","item":[{"name":"addTag","id":"17340159-af34-4a5e-a694-8bb49d6a9270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"tag_name","value":"Lead","type":"text","description":"String. Required.
\nThe tag name. The maximum length is 255 characters.
\n"},{"key":"tag_color","value":"--red_10","description":"String. Required.
\nThe tag color. The maximum is 20 characters.
\nThe available options are:
\nString Optional.
\nThe tag additional information. The maximum length is 255 characters.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/tags/addTag?domain={{domain}}","description":"Adds a tag.
\n","urlObject":{"protocol":"https","path":["api","v3","tags","addTag"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"8b7a9685-bc65-49e0-acd1-68176eab5dc3","name":"addTag","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your access token."},{"key":"tag_name","value":"ABC customer","type":"text","description":"String. Required.\n\nThe tag name."},{"key":"tag_color","value":"--red_10","description":"String. Required.\n\nThe tag color in HEX format.","type":"text"},{"key":"tag_description","value":"Highest priority requests","description":"String Optional.\n\nThe tag additional information.","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/tags/addTag?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","tags","addTag"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 10:37:32 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"d02c075409cccf973654e4c8543b68ad"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 594,\n \"tag_name\": \"Lead\",\n \"tag_color\": \"--red_10\",\n \"tag_description\": \"Highest priority requests\",\n \"created_by\": 1721,\n \"create_date\": \"2023-05-19 10:37:32\",\n \"edited_by\": null,\n \"edit_date\": null\n }\n}"}],"_postman_id":"17340159-af34-4a5e-a694-8bb49d6a9270"},{"name":"searchTags","id":"f2cc73f3-79a7-4aa6-b261-7fa3d9d306b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"[1,3]","description":"Integer or integer array. Optional.
\nThe particular tag ID to filter.
\n","type":"text","disabled":true},{"key":"tag_name","value":"","type":"text","description":"String. Required.
\nThe particular tag name to filter. The maximum length is 255 characters.
\n","disabled":true},{"key":"tag_description","value":"","type":"text","description":"String Optional.
\nThe particular tag description to filter. The maximum length is 255 characters.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/tags/searchTags?domain={{domain}}","description":"Retrieves a list of available tags.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","tags","searchTags"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"1"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-tag_name"}],"variable":[]}},"response":[{"id":"e148d577-6d9b-4f2b-89b1-a6360115a30b","name":"searchTags","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your access token."},{"key":"id","value":"[1,3]","description":"Integer or integer array. Optional.\n\nThe particular tag ID to filter.","type":"text","disabled":true},{"key":"tag_name","value":"","type":"text","description":"String. Required.\n\nThe particular tag name to filter. The maximum length is 255 characters.","disabled":true},{"key":"tag_description","value":"adadadadadad2","type":"text","description":"String Optional.\n\nThe particular tag description to filter. The tag name. The maximum length is 255 characters.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/tags/searchTags?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","tags","searchTags"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."},{"key":"per-page","value":"1","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","disabled":true},{"key":"sort","value":"-tag_name","description":"String. Optional.\n\nThe sorting criteria.","disabled":true},{"key":"page","value":"2","description":"Integer. Optional.\n\nThe report page number.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 10:43:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"b0953f51417a543b0e590296dd992781"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"5"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"594","type":"text","description":"Integer. Required.
\nThe tag ID. Use the searchTags method to retrieve the list of available tags.
\n"},{"key":"tag_name","value":"Valuable customer","type":"text","description":"String. Optional.
\nThe tag name. The maximum length is 255 characters.
\n"},{"key":"tag_color","value":"--yellow_10","type":"text","description":"String. Optional.
\nThe tag color. The maximum is 20 characters.
\nThe available options are:
\nString Optional.
\nThe tag description. The maximum length is 255 characters.
\nIf the parameter is not passed (or null), the description does not change; if the empty string is passed, the description is erased.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/tags/updateTag?domain={{domain}}","description":"Updates a tag.
\n","urlObject":{"protocol":"https","path":["api","v3","tags","updateTag"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"2d301872-41cd-4446-be10-dc0051bb8091","name":"updateTag","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your access token."},{"key":"id","value":"594","type":"text","description":"Integer. Required.\n\nThe Id of the tag you want to update. Use the searchTags method to retrieve the list of available tags."},{"key":"tag_name","value":"Valuable customer","type":"text","description":"String. Optional.\n\nThe tag name. The maximum length is 255 characters."},{"key":"tag_color","value":"--yellow_10","type":"text","description":"String. Optional.\n\nThe tag color in HEX format. The maximum is 20 characters."},{"key":"tag_description","value":"","type":"text","description":"String Optional.\n\nThe tag description. The maximum length is 255 characters.\n\nIf the parameter is not passed (or null) - the description does not change; if the empty string is passed, the description is erased.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/tags/updateTag?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","tags","updateTag"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 10:55:01 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"c838efe56027df05a5fa28552c65a462"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 594,\n \"tag_name\": \"Valuable customer\",\n \"tag_color\": \"--yellow_10\",\n \"tag_description\": null,\n \"created_by\": 1721,\n \"create_date\": \"2023-05-19 10:37:32\",\n \"edited_by\": 1721,\n \"edit_date\": \"2023-05-19 10:55:01\"\n }\n}"}],"_postman_id":"306b31c8-6824-49ab-bf55-fb08389d11ff"},{"name":"deleteTag","id":"4524fe68-35c8-4e23-b6ae-ce5153a5883d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"205","type":"text","description":"Integer. Required.
\nThe tag ID. Use the searchTags method to retrieve the list of available tags.
\n"}]},"url":"https://{{host}}/api/v3/tags/deleteTag?domain={{domain}}","description":"Deletes a tag.
\n","urlObject":{"protocol":"https","path":["api","v3","tags","deleteTag"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"1c066d29-d673-4d0d-b8d3-b83c47f833e6","name":"deleteTag","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"Your access token."},{"key":"id","value":"205","type":"text","description":"Integer. Required.\n\nThe ID of the tag you want to delete. Use the searchTags method to retrieve the list of available tags."}]},"url":{"raw":"https://{{host}}/api/v3/tags/deleteTag?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","tags","deleteTag"],"query":[{"key":"domain","value":"{{domain}}","type":"text","description":"Your account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 May 2023 10:56:16 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"dede3dda62d42cfffc7f232b9c5942f2"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"4524fe68-35c8-4e23-b6ae-ce5153a5883d"}],"id":"a2d23a89-b0d0-4d96-aa2a-7f6862404c47","description":"This folder contains actions you may need to manage tags.
\nThe tagging feature allows you to assign tags (labels) to your calls and chats based on certain properties, such as call duration, conversation content, or customer priority.
\n","_postman_id":"a2d23a89-b0d0-4d96-aa2a-7f6862404c47"},{"name":"topics","item":[{"name":"createTopic","id":"9b454799-f1e6-4dc5-95d3-00d75623b746","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"name","value":"Discounts and sales","type":"text","description":"String. Required.
\nThe topic name.
\n"},{"key":"topic_set_id","value":"438","type":"text","description":"Integer. Required.
\nThe ID of the topic set that will contain the new topic. Use the searchTopicSets method to retrieve the list of available topic sets.
\n"},{"key":"parent_topic_id","value":"","type":"text","description":"Integer. Optional.
\nThe parent topic ID that will nest the new topic. Use the searchTopics method to retrieve the list of available topics.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/topics/createTopic?domain={{domain}}","description":"Creates a topic.
\n","urlObject":{"protocol":"https","path":["api","v3","topics","createTopic"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"428e079d-a224-4292-a696-88103c979f38","name":"createTopic","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"name","value":"Discounts and sales","type":"text","description":"String. Required.\n\nThe topic name."},{"key":"topic_set_id","value":"438","type":"text","description":"Integer. Required.\n\nThe ID of the topic set that will contain the new topic. Use the searchTopicSets method to retrieve the list of available topic sets."},{"key":"parent_topic_id","value":"","type":"text","description":"Integer. Optional.\n\nThe parent topic ID that will nest the new topic. Use the searchTopics method to retrieve the list of available topics.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/topics/createTopic?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topics","createTopic"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 23 May 2023 10:01:19 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"cd12c4f4f940f0d13d02e4c89c506776"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 1901,\n \"name\": \"Discounts and sales\",\n \"topic_set_id\": 438,\n \"parent_topic_id\": null,\n \"path\": \"438.1901\",\n \"create_date\": \"2023-05-23 10:01:19\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null\n }\n}"}],"_postman_id":"9b454799-f1e6-4dc5-95d3-00d75623b746"},{"name":"searchTopics","id":"68f14017-cfe5-4ce9-a9e9-4ca3feb49786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"ids","value":"[1204,1205,1206,1207,1208,1211,1901]","type":"text","description":"Array. Optional.
\nThe particular topic IDs to filter.
\n"},{"key":"topic_set_id","value":"","type":"text","description":"Integer. Optional.
\nThe particular topic set ID to filter. Use the searchTopicSets method to retrieve the list of available topic sets.
\n","disabled":true},{"key":"parent_topic_id","value":"","type":"text","description":"Integer. Optional.
\nThe particular parent topic ID to filter.
\n","disabled":true},{"key":"name","value":"","type":"text","description":"String. Optional.
\nThe particular topic name to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/topics/searchTopics?domain={{domain}}","description":"Retrieves a list of available topics.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","topics","searchTopics"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"91c30fb5-e0fa-43fa-98e8-f6da4243fb1d","name":"searchTopics","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"ids","value":"[1204,1205,1206,1207,1208,1211,1901]","type":"text","description":"Array. Optional.\n\nThe particular topic IDs to filter."},{"key":"topic_set_id","value":"","type":"text","description":"Integer. Optional.\n\nThe particular topic set ID to filter. Use the searchTopicSets method to retrieve the list of available topic sets.","disabled":true},{"key":"parent_topic_id","value":"","type":"text","description":"Integer. Optional.\n\nThe particular parent topic ID to filter.","disabled":true},{"key":"name","value":"","type":"text","description":"String. Optional.\n\nThe particular topic name to filter.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/topics/searchTopics?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topics","searchTopics"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 23 May 2023 10:06:52 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"0818bd49536044a072f2e60a06637932"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"7"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1204","type":"text","description":"Integer. Required.
\nThe topic ID. Use the searchTopics method to retrieve the list of available topics.
\n"},{"key":"name","value":"Defective goods","type":"text","description":"String. Required.
\nThe topic name.
\n"}]},"url":"https://{{host}}/api/v3/topics/updateTopic?domain={{domain}}","description":"Updates a topic.
\n","urlObject":{"protocol":"https","path":["api","v3","topics","updateTopic"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"8799b859-fce2-49a2-b660-5f53ece65202","name":"updateTopic","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"id","value":"1204","type":"text","description":"Integer. Required.\n\nThe topic ID you want to update. Use the searchTopics method to retrieve the list of available topics."},{"key":"name","value":"Defective goods","type":"text","description":"String. Required.\n\nThe topic name."}]},"url":{"raw":"https://{{host}}/api/v3/topics/updateTopic?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topics","updateTopic"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 23 May 2023 10:10:36 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"232d968b0fc993bd7f26152c36b9a5a0"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 1204,\n \"name\": \"Defective goods\",\n \"topic_set_id\": 305,\n \"parent_topic_id\": null,\n \"path\": \"305.1204\",\n \"create_date\": \"2023-01-31 12:42:02\",\n \"created_by\": 563,\n \"edit_date\": \"2023-05-23 10:10:36\",\n \"edited_by\": 1721\n }\n}"}],"_postman_id":"e84c0b9c-d7c4-4d92-a231-a3ff5bd7702b"},{"name":"deleteTopic","id":"dfc030c0-bab1-4462-a773-354e914bd187","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"1901","type":"text","description":"Integer. Required.
\nThe topic ID. Use the searchTopics method to retrieve the list of available topics.
\n"}]},"url":"https://{{host}}/api/v3/topics/deleteTopic?domain={{domain}}","description":"Deletes a topic.
\n","urlObject":{"protocol":"https","path":["api","v3","topics","deleteTopic"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"6cd7cf4e-cef3-4f79-8e5c-f3f9f7fab7c6","name":"deleteTopic","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"id","value":"1901","type":"text","description":"Integer. Required.\n\nThe topic ID you want to delete. Use the searchTopics method to retrieve the list of available topics."}]},"url":{"raw":"https://{{host}}/api/v3/topics/deleteTopic?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topics","deleteTopic"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 23 May 2023 10:12:15 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"41918ad6535c08876536fad21b580b7b"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 1901\n }\n}"}],"_postman_id":"dfc030c0-bab1-4462-a773-354e914bd187"}],"id":"32c875dd-0820-4400-a7fe-1b8091a58724","description":"The folder contains actions you may need to manage topics.
\nA topic is similar to a tag; it helps you classify customer requests, for example, Central region, Technical support, Customer service department. Topics are grouped into topic sets. A topic set can include individual topics and topics nested in a hierarchical order. Each topic in a set can have up to 5 nesting levels.
\n","_postman_id":"32c875dd-0820-4400-a7fe-1b8091a58724"},{"name":"topicSets","item":[{"name":"createTopicSet","id":"928e2f5b-05dd-40a0-987e-e8bdae727ebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"name","value":"Prospect","type":"text","description":"String. Required.
\nThe topic set name.
\n"},{"key":"description","value":"A potential customer; needs an RFQ.","type":"text","description":"String. Optional.
\nThe topic set description.
\n"}]},"url":"https://{{host}}/api/v3/topicSets/createTopicSet?domain={{domain}}","description":"Creates a topic set.
\n","urlObject":{"protocol":"https","path":["api","v3","topicSets","createTopicSet"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"bb738777-e20f-456f-bd61-8a61f48a0417","name":"createTopicSet","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"name","value":"Prospect","type":"text","description":"String. Required. \n\nThe topic set name."},{"key":"description","value":"A potential customer; needs an RFQ.","type":"text","description":"String. Optional.\n\nThe topic set description."}]},"url":{"raw":"https://{{host}}/api/v3/topicSets/createTopicSet?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topicSets","createTopicSet"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 12:43:25 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"9a6b02b7c45978a150d65b8e85e86268"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 438,\n \"name\": \"Prospect\",\n \"description\": \"A potential customer; needs an RFQ.\",\n \"create_date\": \"2023-05-22 12:43:25\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null\n }\n}"}],"_postman_id":"928e2f5b-05dd-40a0-987e-e8bdae727ebb"},{"name":"searchTopicSets","id":"c12b264c-2017-4651-b6d0-bffc44a20310","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"name","value":"Prospect","type":"text","description":"String. Optional.
\nThe particular topic set name to filter.
\n"},{"key":"description","value":"","type":"text","description":"String. Optional.
\nThe particular topic set description to filter.
\n","disabled":true},{"key":"keyword","value":"5","type":"text","description":"String. Optional.
\nAny keyword to filter.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/topicSets/searchTopicSets?domain={{domain}}","description":"Retrieves a list of available topic sets.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","topicSets","searchTopicSets"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"b081207e-3815-4d76-8131-1c4cf6b35b3d","name":"searchTopicSets","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"name","value":"Prospect","type":"text","description":"String. Optional.\n\nThe particular topic set name to filter."},{"key":"description","value":"","type":"text","description":"String. Optional.\n\nThe particular topic set description to filter.","disabled":true},{"key":"keyword","value":"5","type":"text","description":"String. Optional.\n\nAny keyword to filter.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/topicSets/searchTopicSets?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topicSets","searchTopicSets"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 12:45:12 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"982922dc1f3f07bf4daec14d71a07f7f"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"438","type":"text","description":"Integer. Required.
\nThe topic set ID. Use the searchTopicSets method to retrieve the list of available topic sets.
\n"},{"key":"name","value":"Prospect from US","type":"text","description":"String. Optional.
\nThe topic set name.
\n"},{"key":"description","value":"A potential customer; needs an RFQ.","type":"text","description":"String. Optional.
\nThe topic set description.
\n"}]},"url":"https://{{host}}/api/v3/topicSets/updateTopicSet?domain={{domain}}","description":"Updates a topic set.
\n","urlObject":{"protocol":"https","path":["api","v3","topicSets","updateTopicSet"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"f24e107b-c34f-4079-bba8-2f4dcc208ccb","name":"updateTopicSet","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"id","value":"438","type":"text","description":"Integer. Required.\n\nThe topic set ID you want to update. Use the searchTopicSets method to retrieve the list of available topic sets."},{"key":"name","value":"Prospect from US","type":"text","description":"String. Optional.\n\nThe topic set name."},{"key":"description","value":"A potential customer; needs an RFQ.","type":"text","description":"String. Optional.\n\nThe topic set description."}]},"url":{"raw":"https://{{host}}/api/v3/topicSets/updateTopicSet?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topicSets","updateTopicSet"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 12:49:05 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"377c8131ac79cdad790ae6af72a30c07"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 438,\n \"name\": \"Prospect from US\",\n \"description\": \"A potential customer; needs an RFQ.\",\n \"create_date\": \"2023-05-22 12:43:25\",\n \"created_by\": 1721,\n \"edit_date\": \"2023-05-22 12:49:05\",\n \"edited_by\": 1721\n }\n}"}],"_postman_id":"c3b2752d-a68f-489a-87d8-0886de4656bd"},{"name":"deleteTopicSet","id":"3c68a057-1446-412d-9e1d-7f2c86c5c170","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"2","type":"text","description":"Integer. Required.
\nThe topic set ID. Use the searchTopicSets method to retrieve the list of available topic sets.
\n"}]},"url":"https://{{host}}/api/v3/topicSets/deleteTopicSet?domain={{domain}}","description":"Deletes a topic set.
\n","urlObject":{"protocol":"https","path":["api","v3","topicSets","deleteTopicSet"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"ae45d6e7-89eb-4946-86b4-b1d9c2b5ec15","name":"deleteTopicSet","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","equals":true,"description":"Your access token."},{"key":"id","value":"2","type":"text","description":"Integer. Required.\n\nThe topic set ID you want to delete."}]},"url":{"raw":"https://{{host}}/api/v3/topicSets/deleteTopicSet?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","topicSets","deleteTopicSet"],"query":[{"key":"domain","value":"{{domain}}","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 22 May 2023 12:49:57 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"72ecb446c5ad16ad2f4159d8f3c56b9f"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"3c68a057-1446-412d-9e1d-7f2c86c5c170"}],"id":"6d6c4bce-c1a3-440e-86ca-f5e04b7777c7","description":"The folder contains actions you may need to manage topic sets.
\nA topic set is a group of topics used to classify customer requests. A topic set can include individual topics and topics nested in a hierarchical order. Each topic in a set can have up to 5 nesting levels.
\n","_postman_id":"6d6c4bce-c1a3-440e-86ca-f5e04b7777c7"},{"name":"user","item":[{"name":"searchUsers","id":"1710996c-6d6a-4047-a3b2-21e780c6eb21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"username","value":"","type":"text","description":"String. Optional.
\nThe particular username to filter. The maximum length is 255 characters.
\n","disabled":true},{"key":"email","value":"","type":"text","description":"String. Optional.
\nThe particular user email address to filter.
\n","disabled":true},{"key":"full_name","value":"","type":"text","description":"String. Optional.
\nThe particular user full name (first/middle/last) to filter.
\n","disabled":true},{"key":"name","value":"","type":"text","description":"String. Optional.
\nThe particular name to filter. The parameter searches for matches in 'username' and 'full_name'. The maximum length is 255 characters.
\n","disabled":true},{"key":"role_id","value":"","type":"text","description":"Integer. Optional.
\nThe particular role ID to filter. The maximum length is 255 characters.
\nThe options are:\nOwner - 2\nAdministrator - 3\nManager - 4\nSupervisor - 7\nAgent - 5
\n","disabled":true},{"key":"group_id","value":"","type":"text","description":"Integer. Optional.
\nThe particular user group ID to filter. Use the searchGroups method to retrieve the list of available user groups. The maximum length is 255 characters.
\n","disabled":true},{"key":"deleted","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the user is deleted. The options are 1|0|true|false.
\n","disabled":true},{"key":"include_deleted","value":"","type":"text","description":"Boolean. Optional.
\nSpecifies whether the report includes deleted users. The options are 1|0|true|false.
\n","disabled":true},{"key":"id","value":"563","type":"text","description":"Integer array. Optional.
\nThe particular user ID(s) to filter. The maximum length is 2147483647, the minimum is 1. Array example: [integer].
\n"},{"key":"group_ids","value":"","type":"text","description":"Array. Optional.
\nThe particular user group IDs to filter. Use the searchGroups method to retrieve the list of available user group IDs. Example: [integer].
\nIf you specify [null], the response returns all users who do not belong to any group.
\n","disabled":true},{"key":"with_extension","value":"false","description":"Boolean. Optional.
\nSpecifies whether the report should include user extensions. The options are true|false.
\n","type":"text","disabled":true}]},"url":"https://{{host}}/api/v3/user/searchUsers?domain={{domain}}","description":"Retrieves the list of users on the account.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\nThis method can return the following errors:
\n","urlObject":{"protocol":"https","path":["api","v3","user","searchUsers"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe report page number.
\n","type":"text/plain"},"key":"page","value":""},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":""},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":""}],"variable":[]}},"response":[{"id":"eac8bec6-1e8d-4a86-9a98-2a42c69d0067","name":"searchUsers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"username","value":"","type":"text","disabled":true},{"key":"email","value":"","type":"text","disabled":true},{"key":"full_name","value":"","type":"text","disabled":true},{"key":"name","value":"","type":"text","disabled":true},{"key":"role_id","value":"","type":"text","disabled":true},{"key":"group_id","value":"","type":"text","disabled":true},{"key":"deleted","value":"","type":"text","disabled":true},{"key":"include_deleted","value":"","type":"text","disabled":true},{"key":"id","value":"563","type":"text"},{"key":"group_ids","value":"","type":"text","disabled":true},{"key":"with_extension","value":"false","description":"Boolean. Optional.\n\nSpecifies whether the report should include user extensions. The options are true|false.\n","type":"text","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/user/searchUsers?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","user","searchUsers"],"query":[{"key":"domain","value":"{{domain}}","description":"Your account name."},{"key":"page","value":"","description":"Integer. Optional.\n\nThe report page number.","disabled":true},{"key":"per-page","value":"","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","disabled":true},{"key":"sort","value":"","description":"The sorting criteria.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 17 May 2023 15:38:47 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"64501478d3f14d3dc0c2726592d7a483"},{"key":"Vary","value":"Accept"},{"key":"X-Rate-Limit-Limit","value":"20"},{"key":"X-Rate-Limit-Remaining","value":"19"},{"key":"X-Rate-Limit-Reset","value":"0"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"This folder contains actions you may need to search for specific users on the account.
\n","_postman_id":"e1f83a0c-c224-408e-b37f-b5815c498ef0"},{"name":"usergroup","item":[{"name":"addGroup","id":"11397e2a-b4cb-4b66-939d-90edaaa57934","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"group_title","value":"Support 2 line","type":"text","description":"String. Required.
\nThe group name. The maximum length is 1000 characters.
\n"},{"key":"can_inbound_calls","value":"true","type":"text","description":"Boolean. Required.
\nSpecifies whether the group members can process inbound calls. The available option is true.
\n"},{"key":"can_outbound_calls","value":"false","type":"text","description":"Boolean. Required.
\nSpecifies whether the group members can perform outbound calls via softphone.
\n"},{"key":"can_change_caller_id","value":"false","type":"text","description":"Boolean. Required if can_outbound_calls is true.
\nSpecifies whether the group members can change the Caller ID in outbound calls via softphone. The default setting is false.
\n","disabled":true},{"key":"outbound_phone_id","value":"132","type":"text","description":"Integer. Required if outbound_caller_id and outbound_sip_number_id are empty and can_outbound_calls is true.
\nThe identifier of the phone number to use for the group's outbound calls. This is the ID of the phone number you purchased in Voximplant Kit.\nUse the searchNumbers method to retrieve available phone numbers.
\n","disabled":true},{"key":"outbound_caller_id","value":"25","type":"text","description":"Integer. Required if outbound_phone_id and outbound_sip_number_id are empty and can_outbound_calls is true.
\nThe identifier of the Caller ID to use for the group's outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"outbound_sip_number_id","value":"12","description":"Integer. Required if outbound_phone_id and outbound_caller_id are empty and can_outbound_calls is true.
\nThe ID of the external number to use for the group's outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.
\n","type":"text","disabled":true},{"key":"users_ids","value":"[563, 1777]","type":"text","description":"JSON (integer array). Required.
\nThe group members' user IDs. Use the searchUsers method to retrieve the list of user IDs.
\n"},{"key":"number_extension","value":"2262334","type":"text","description":"Integer. Optional.
\nThe group extension number. The minimum length is 1 digit, and the maximum is 9999999999.
\n","disabled":true},{"key":"dialing_strategy","value":"all_consistently","type":"text","description":"String. Optional.
\nThe group dialing strategy. The setting defines how the system distributes customer calls between the group agents.
\nThe available options are:
\nInteger. Optional.
\nThe maximum time an agent has to answer a call before it is routed to the next agent. The minimum value is 10 sec, and the maximum is 60 sec.
\n","disabled":true},{"key":"group_dialing_max_waiting_time_sec","value":"75","type":"text","description":"Integer. Required if dialing_strategy is all_consistently.
\nThe maximum time a customer waits on the line for an agent’s response. The system cancels the call if a customer waits longer than the time specified. The minimum value is 10 sec, the maximum is 300 sec, and the default is 60.
\n","disabled":true},{"key":"group_dialing_media_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether you can set the specific audio recording to play while dialing the group and thus override settings configured in other sections.
\n","disabled":true},{"key":"group_dialing_media_id","value":"299","type":"text","description":"Integer. Required if group_dialing_media_enabled is true.
\nThe ID of the audio recording to play to customers while dialing the group. Use the searchMedia method to retrieve the list of available media file IDs.
\n","disabled":true},{"key":"supervisors_ids","value":"[1147]","type":"text","description":"JSON (integer array). Optional.
\nThe IDs of the supervisors assigned to manage the group. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as group supervisors.
\n"}]},"url":"https://{{host}}/api/v3/usergroup/addGroup?domain={{domain}}","description":"Creates a user group.
\n","urlObject":{"protocol":"https","path":["api","v3","usergroup","addGroup"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"4a923a33-59e3-46fc-a09c-74b75d432ef1","name":"addGroup","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"group_title","value":"Support 2 line","type":"text","description":"String. Required.\n\nThe group name. The maximum length is 1000 characters."},{"key":"can_inbound_calls","value":"true","type":"text","description":"Boolean. Required.\n\nSpecifies whether the group members can process inbound calls. The available option is true."},{"key":"can_outbound_calls","value":"false","type":"text","description":"Boolean. Required.\n\nSpecifies whether the group members can perform outbound calls via softphone."},{"key":"can_change_caller_id","value":"false","type":"text","description":"Boolean. Required if can_outbound_calls is true.\n\nSpecifies whether the group members can change the Caller ID in outbound calls via softphone. The default setting is false.","disabled":true},{"key":"outbound_phone_id","value":"132","type":"text","description":"Integer. Required if outbound_caller_id and outbound_sip_number_id are empty and can_outbound_calls is true.\n\nThe identifier of the phone number to use for the group's outbound calls. This is the ID of the phone number you purchased in Voximplant Kit.\nUse the searchNumbers method to retrieve available phone numbers.","disabled":true},{"key":"outbound_caller_id","value":"25","type":"text","description":"Integer. Required if outbound_phone_id and outbound_sip_number_id are empty and can_outbound_calls is true.\n\nThe identifier of the Caller ID to use for the group's outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.","disabled":true},{"key":"outbound_sip_number_id","value":"12","description":"Integer. Required if outbound_phone_id and outbound_caller_id are empty and can_outbound_calls is true.\n\nThe ID of the external number to use for the group's outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.","type":"text","disabled":true},{"key":"users_ids","value":"[563, 1777]","type":"text","description":"JSON (integer array). Required.\n\nThe group members' user IDs. Use the searchUsers method to retrieve the list of user IDs."},{"key":"number_extension","value":"2262334","type":"text","description":"Integer. Optional.\n\nThe group extension number. The minimum length is 1 digit, and the maximum is 9999999999.","disabled":true},{"key":"dialing_strategy","value":"all_consistently","type":"text","description":"String. Optional.\n\nThe group dialing strategy. The setting defines how the system distributes customer calls between the group agents.\n\nThe available options are:\n\none_random - Random call distribution. The system distributes calls evenly, so each agent could answer an equal number of calls. The call is routed to one agent only. To receive calls, agents must be Online. This option is the default one.\n\nall_parallel - Simultaneous routing. The call is routed simultaneously to all group agents. The first agent to answer the phone gets the call. To receive calls, agents must be Online.\n\nall_consistently - Sequential routing. The system searches through the agents in the predefined order until one of the agents answers the call. To receive calls, agents must be Online.\n","disabled":true},{"key":"agent_dialing_max_waiting_time_sec","value":"15","type":"text","description":"Integer. Optional.\n\nThe maximum time an agent has to answer a call before it is routed to the next agent. The minimum value is 10 sec, and the maximum is 60 sec.","disabled":true},{"key":"group_dialing_max_waiting_time_sec","value":"75","type":"text","description":"Integer. Required if dialing_strategy is all_consistently.\n\nThe maximum time a customer waits on the line for an agent’s response. The system cancels the call if a customer waits longer than the time specified. The minimum value is 10 sec, the maximum is 300 sec, and the default is 60.","disabled":true},{"key":"group_dialing_media_enabled","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether you can set the specific audio recording to play while dialing the group and thus override settings configured in other sections.","disabled":true},{"key":"group_dialing_media_id","value":"299","type":"text","description":"Integer. Required if group_dialing_media_enabled is true.\n\nThe ID of the audio recording to play to customers while dialing the group. Use the searchMedia method to retrieve the list of available media file IDs.","disabled":true},{"key":"supervisors_ids","value":"[1147]","type":"text","description":"JSON (integer array). Optional.\n\nThe IDs of the supervisors assigned to manage the group. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as group supervisors."}]},"url":{"raw":"https://{{host}}/api/v3/usergroup/addGroup?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","usergroup","addGroup"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:14:50 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"60883a2f680035199b72f7ab4efde2e7"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 895,\n \"group_title\": \"Support 2 line\",\n \"domain_id\": 169,\n \"create_date\": \"2023-06-19 10:14:50\",\n \"created_by\": 1721,\n \"edit_date\": null,\n \"edited_by\": null,\n \"can_inbound_calls\": true,\n \"can_outbound_calls\": false,\n \"outbound_phone_id\": null,\n \"outbound_caller_id\": null,\n \"can_internal_calls\": true,\n \"can_change_caller_id\": false,\n \"can_hold_record\": false,\n \"hold_media_id\": null,\n \"number_extension\": null,\n \"users_ids\": [\n 563,\n 1777\n ],\n \"dialing_strategy\": \"one_random\",\n \"agent_dialing_max_waiting_time_sec\": null,\n \"group_dialing_max_waiting_time_sec\": 60,\n \"group_dialing_media_enabled\": null,\n \"group_dialing_media_id\": null,\n \"supervisors\": [\n {\n \"id\": 1147,\n \"username\": \"John\",\n \"email\": \"jsmith1@voximplant.com\",\n \"avatar\": \"https://system/photos/avatar.png\",\n \"full_name\": \"John Smith\"\n }\n ],\n \"outbound_sip_number_id\": null,\n \"can_agent_access_calls_recordings\": false\n }\n}"}],"_postman_id":"11397e2a-b4cb-4b66-939d-90edaaa57934"},{"name":"searchGroups","id":"6baa2e19-8d77-42d6-96d0-0ad4a343f633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"[895]","type":"text","description":"Integer|JSON (integer array). Optional.
\nThe particular group ID(s) to filter.
\n"},{"key":"group_title","value":"Support 2 line","type":"text","description":"String. Optional.
\nThe particular group name to filter.
\n"}]},"url":"https://{{host}}/api/v3/usergroup/searchGroups?domain={{domain}}","description":"Retrieves a list of user groups available in the account.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","usergroup","searchGroups"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"disabled":true,"description":{"content":"Integer. Optional.
\nThe number of records per page (default value is 20, min = 1, max = 50).
\n","type":"text/plain"},"key":"per-page","value":"0"},{"disabled":true,"description":{"content":"String. Optional.
\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"fbbfb870-f6fc-4a04-b3f8-750099027081","name":"searchGroups","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"[895]","type":"text","description":"Integer|JSON (integer array). Optional.\n\nThe particular group ID(s) to filter."},{"key":"group_title","value":"Support 2 line","type":"text","description":"String. Optional.\n\nThe particular group title to filter."}]},"url":{"raw":"https://{{host}}/api/v3/usergroup/searchGroups?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","usergroup","searchGroups"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"per-page","value":"0","description":"Integer. Optional.\n\nThe number of records per page (default value is 20, min = 1, max = 50).","disabled":true},{"key":"sort","value":"-id","description":"String. Optional.\n\nThe query parameter(s) to sort items returned in a response. Add '-' for DESC sorting.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:17:29 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"97ee6712fc6c56fed753e939a82fb005"},{"key":"Vary","value":"Accept"},{"key":"X-Pagination-Total-Count","value":"1"},{"key":"X-Pagination-Page-Count","value":"1"},{"key":"X-Pagination-Current-Page","value":"1"},{"key":"X-Pagination-Per-Page","value":"20"},{"key":"Link","value":"String. Required.
\nYour API token.
\n"},{"key":"group_id","value":"895","description":"Integer. Required.
\nThe group ID. Use the searchGroups method to retrieve the list of available groups.
\n","type":"text"},{"key":"group_title","value":"Support 2 line","type":"text","description":"String. Required.
\nThe group name. The maximum length is 1000 characters.
\n"},{"key":"can_outbound_calls","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the group members can perform outbound calls via softphone.
\n"},{"key":"can_change_caller_id","value":"false","type":"text","description":"Boolean. Optional.
\nSpecifies whether the group members can change the Caller ID in outbound calls via softphone.
\nNOTE! The parameter only works if can_outbound_calls is passed.
\n","disabled":true},{"key":"outbound_phone_id","value":"268","type":"text","description":"Integer. Required if can_outbound_calls is true.
\nThe identifier of the phone number used for the group's outbound calls. This is the ID of the phone number you purchased in Voximplant Kit.\nUse the searchNumbers method to retrieve available phone numbers.
\n"},{"key":"outbound_caller_id","value":"25","type":"text","description":"Integer. Required if can_outbound_calls is true.
\nThe identifier of the Caller ID used for the group's outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.
\n","disabled":true},{"key":"outbound_sip_number_id","value":"12","description":"Integer. Required if can_outbound_calls is true.
\nThe ID of the external number used for the group's outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.
\n","type":"text","disabled":true},{"key":"users_ids","value":"[562]","type":"text","description":"JSON (integer array). Optional.
\nThe group members' user IDs. Use the searchUsers method to retrieve the list of user IDs.
\n","disabled":true},{"key":"number_extension","value":"22621","type":"text","description":"Integer. Optional. Nullable.
\nThe group extension number. The minimum length is 1 digit, and the maximum is 9999999999.
\n"},{"key":"dialing_strategy","value":"all_consistently","type":"text","description":"String. Optional.
\nThe group dialing strategy. The setting defines how the system distributes customer calls between the group agents.
\nThe available options are:
\nInteger. Optional.
\nThe maximum time an agent has to answer a call before it is routed to the next agent. The minimum value is 10 sec, and the maximum is 60 sec.
\n","disabled":true},{"key":"group_dialing_max_waiting_time_sec","value":"75","type":"text","description":"Integer. Optional.
\nThe maximum time a customer waits on the line for an agent’s response. The system cancels the call if a customer waits longer than the time specified. The minimum value is 10 sec, the maximum is 300 sec, and the default is 60.
\n","disabled":true},{"key":"group_dialing_media_enabled","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether you can set the specific audio recording to play while dialing this group and thus override settings configured in other sections.
\n","disabled":true},{"key":"group_dialing_media_id","value":"299","type":"text","description":"Integer. Required if group_dialing_media_enabled is true.
\nThe ID of the audio recording to play to customers while dialing the group. Use the searchMedia method to retrieve the list of available media file IDs.
\n","disabled":true},{"key":"supervisors_ids","value":"[1147]","type":"text","description":"JSON (integer array). Optional.
\nThe IDs of the supervisors assigned to manage the group. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as group supervisors.
\n"}]},"url":"https://{{host}}/api/v3/usergroup/updateGroup?domain={{domain}}","description":"Updates a user group.
\n","urlObject":{"protocol":"https","path":["api","v3","usergroup","updateGroup"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"8119a083-f84c-4da1-b585-169db7f91732","name":"updateGroup","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"group_id","value":"895","description":"Integer. Required.\n\nThe group ID. Use the searchGroups method to retrieve the list of available groups.","type":"text"},{"key":"group_title","value":"Support 2 line","type":"text","description":"String. Required.\n\nThe group name. The maximum length is 1000 characters."},{"key":"can_outbound_calls","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the group members can perform outbound calls via softphone."},{"key":"can_change_caller_id","value":"false","type":"text","description":"Boolean. Optional.\n\nSpecifies whether the group members can change the Caller ID in outbound calls via softphone.","disabled":true},{"key":"outbound_phone_id","value":"268","type":"text","description":"Integer. Required if can_outbound_calls is true.\n\nThe identifier of the phone number used for the group's outbound calls. This is the ID of the phone number you purchased in Voximplant Kit.\nUse the searchNumbers method to retrieve available phone numbers."},{"key":"outbound_caller_id","value":"25","type":"text","description":"Integer. Required if can_outbound_calls is true.\n\nThe identifier of the Caller ID used for the group's outbound calls. \nThis is the ID of the custom phone number you added and verified in Voximplant Kit. Use the searchCallerIDs method to retrieve available Caller IDs.","disabled":true},{"key":"outbound_sip_number_id","value":"12","description":"Integer. Required if can_outbound_calls is true.\n\nThe ID of the external number used for the group's outbound calls. An external number is the one you add and associate with a SIP trunk for outbound SIP calls. Use the searchSipNumber method to retrieve the list of available external numbers.","type":"text","disabled":true},{"key":"users_ids","value":"[562]","type":"text","description":"JSON (integer array). Optional.\n\nThe group members' user IDs. Use the searchUsers method to retrieve the list of user IDs.","disabled":true},{"key":"number_extension","value":"22621","type":"text","description":"Integer. Optional. Nullable.\n\nThe group extension number. The minimum length is 1 digit, and the maximum is 9999999999."},{"key":"dialing_strategy","value":"all_consistently","type":"text","description":"String. Optional.\n\nThe group dialing strategy. The setting defines how the system distributes customer calls between the group agents.\n\nThe available options are:\n\none_random - Random call distribution. The system distributes calls evenly, so each agent could answer an equal number of calls. The call is routed to one agent only. To receive calls, agents must be Online. This option is the default one.\n\nall_parallel - Simultaneous routing. The call is routed simultaneously to all group agents. The first agent to answer the phone gets the call. To receive calls, agents must be Online.\n\nall_consistently - Sequential routing. The system searches through the agents in the predefined order until one of the agents answers the call. To receive calls, agents must be Online.\n","disabled":true},{"key":"agent_dialing_max_waiting_time_sec","value":"15","type":"text","description":"Integer. Optional.\n\nThe maximum time an agent has to answer a call before it is routed to the next agent. The minimum value is 10 sec, and the maximum is 60 sec.","disabled":true},{"key":"group_dialing_max_waiting_time_sec","value":"75","type":"text","description":"Integer. Optional.\n\nThe maximum time a customer waits on the line for an agent’s response. The system cancels the call if a customer waits longer than the time specified. The minimum value is 10 sec, the maximum is 300 sec, and the default is 60.","disabled":true},{"key":"group_dialing_media_enabled","value":"true","type":"text","description":"Boolean. Optional.\n\nSpecifies whether you can set the specific audio recording to play while dialing this group and thus override settings configured in other sections.","disabled":true},{"key":"group_dialing_media_id","value":"299","type":"text","description":"Integer. Required if group_dialing_media_enabled is true.\n\nThe ID of the audio recording to play to customers while dialing the group. Use the searchMedia method to retrieve the list of available media file IDs.","disabled":true},{"key":"supervisors_ids","value":"[1147]","type":"text","description":"JSON (integer array). Optional.\n\nThe IDs of the supervisors assigned to manage the group. Use the searchUsers method to retrieve the list of user IDs. Note that only users with the Supervisor role can be assigned as group supervisors."}]},"url":{"raw":"https://{{host}}/api/v3/usergroup/updateGroup?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","usergroup","updateGroup"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:21:38 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"31e00e99271211605e8bd2d7128cd538"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": {\n \"id\": 895,\n \"group_title\": \"Support 2 line\",\n \"domain_id\": 169,\n \"create_date\": \"2023-06-19 10:14:51\",\n \"created_by\": 1721,\n \"edit_date\": \"2023-06-19 10:21:38\",\n \"edited_by\": 1721,\n \"can_inbound_calls\": true,\n \"can_outbound_calls\": true,\n \"outbound_phone_id\": 268,\n \"outbound_caller_id\": null,\n \"can_internal_calls\": true,\n \"can_change_caller_id\": false,\n \"can_hold_record\": false,\n \"hold_media_id\": null,\n \"number_extension\": {\n \"id\": 40408,\n \"number\": \"22621\",\n \"active\": true\n },\n \"users_ids\": [\n 1777,\n 563\n ],\n \"dialing_strategy\": \"one_random\",\n \"agent_dialing_max_waiting_time_sec\": null,\n \"group_dialing_max_waiting_time_sec\": 60,\n \"group_dialing_media_enabled\": null,\n \"group_dialing_media_id\": null,\n \"supervisors\": [\n {\n \"id\": 1147,\n \"username\": \"John\",\n \"email\": \"jsmith1@voximplant.com\",\n \"avatar\": \"https://system/photos/avatar.png\",\n \"full_name\": \"John Smith\"\n }\n ],\n \"outbound_sip_number_id\": null,\n \"can_agent_access_calls_recordings\": false\n }\n}"}],"_postman_id":"2b6b5f22-77da-47fa-afdb-be5fcf9cc35c"},{"name":"deleteGroup","id":"cac8d7a1-1745-4716-9431-9cae40750790","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"group_id","value":"895","type":"text","description":"Integer. Required.
\nThe group ID. Use the searchGroups method to retrieve the list of available groups.
\n"}]},"url":"https://{{host}}/api/v3/usergroup/deleteGroup?domain={{domain}}","description":"Deletes a user group.
\n","urlObject":{"protocol":"https","path":["api","v3","usergroup","deleteGroup"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"6340d5af-0838-4d6b-bf5a-35651b834967","name":"deleteGroup","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"group_id","value":"12","type":"text","description":"Integer. Required.\n\nThe group ID. Use the searchGroups method to retrieve the list of available groups."}]},"url":{"raw":"https://{{host}}/api/v3/usergroup/deleteGroup?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","usergroup","deleteGroup"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Mon, 19 Jun 2023 10:22:42 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.1.13"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"https://*"},{"key":"X-Kit-Request-Id","value":"39604985d556ff7f47300b7ee3741609"},{"key":"Vary","value":"Accept"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"cac8d7a1-1745-4716-9431-9cae40750790"}],"id":"5874bd5d-8cd1-42dc-afc3-03983ae68f83","description":"The folder contains actions you may need to manage user groups.
\nA user group is a team of agents who share similar duties and responsibilities. A group is managed by a supervisor.
\nNOTE: Every user can be a member of only one group. If you need to assign a user to a different group, you first need to unassign them from the current one.
\n","_postman_id":"5874bd5d-8cd1-42dc-afc3-03983ae68f83"},{"name":"whatsappHsmTemplates","item":[{"name":"search","id":"29c90d95-c06f-4cef-a021-4810194ca8b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"ids","value":"[10,15,20]","type":"text","description":"JSON array. Optional.
\nThe particular HSM template IDs to filter.
\n","disabled":true},{"key":"collection_ids","value":"[5]","type":"text","description":"JSON array. Optional.
\nThe particular template collection IDs to filter.
\n","disabled":true},{"key":"statuses","value":"[\"draft\"]","type":"text","description":"JSON array enum. Optional.
\nThe template status to filter. The options are draft | pending | approved | rejected | disabled | paused | not_sent.
\n","disabled":true}]},"url":"https://{{host}}/api/v3/whatsappHsmTemplates/search?domain={{domain}}&sort=-id","description":"Retrieves a list of WhatsApp HSM templates.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","whatsappHsmTemplates","search"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Optional.
\nThe query parameter to sort items returned in a response. Add '-' for DESC sorting.
\n","type":"text/plain"},"key":"sort","value":"-id"}],"variable":[]}},"response":[{"id":"dff12561-e597-4bf5-ba94-d44c50dff974","name":"search","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"ids","value":"[10,15,20]","type":"text","description":"JSON array. Optional.\n\nThe particular HSM template IDs to filter.","disabled":true},{"key":"collection_ids","value":"[5]","type":"text","description":"JSON array. Optional.\n\nThe particular template collection IDs to filter.","disabled":true},{"key":"statuses","value":"[\"draft\"]","type":"text","description":"JSON array enum. Optional.\n\nThe template status to filter. The options are draft | pending | approved | rejected | disabled | paused | not_sent.","disabled":true}]},"url":{"raw":"https://{{host}}/api/v3/whatsappHsmTemplates/search?domain={{domain}}&sort=-id","protocol":"https","host":["{{host}}"],"path":["api","v3","whatsappHsmTemplates","search"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name.","type":"text"},{"key":"sort","value":"-id","description":"String. Optional.\n\nThe query parameter to sort items returned in a response. Add '-' for DESC sorting.","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": [\r\n {\r\n \"id\": 1085,\r\n \"channel_id\": 2191,\r\n \"collection_id\": 816,\r\n \"name\": \"sale\",\r\n \"category\": \"marketing\",\r\n \"status\": \"approved\",\r\n \"language\": \"en\",\r\n \"header_type\": \"text\",\r\n \"header_text\": \"Hello\",\r\n \"header_attachment_id\": null,\r\n \"header_example_text_param\": null,\r\n \"header_example_media_url\": null,\r\n \"text\": \"Please collect your parcel.\",\r\n \"text_example_params\": null,\r\n \"footer\": null,\r\n \"buttons\": null,\r\n \"button_example_url_text\": null,\r\n \"external_id\": 110570,\r\n \"create_date\": \"2024-12-13 08:43:08\",\r\n \"created_by\": 5852,\r\n \"edit_date\": null,\r\n \"edited_by\": null\r\n },\r\n {\r\n \"id\": 1079,\r\n \"channel_id\": 2191,\r\n \"collection_id\": 806,\r\n \"name\": \"accounts\",\r\n \"category\": \"utility\",\r\n \"status\": \"pending\",\r\n \"language\": \"en\",\r\n \"header_type\": \"text\",\r\n \"header_text\": \"Hello{{name}}\",\r\n \"header_attachment_id\": null,\r\n \"header_example_text_param\": \"Mr. Smith\",\r\n \"header_example_media_url\": null,\r\n \"text\": \"Your account is frozen. Would you like to unfreeze it?\",\r\n \"text_example_params\": null,\r\n \"footer\": \"МС\",\r\n \"buttons\": [\r\n {\r\n \"text\": \"Yes\",\r\n \"type\": \"quick_reply\",\r\n \"payload\": \"1\"\r\n }\r\n ],\r\n \"button_example_url_text\": null,\r\n \"external_id\": 109994,\r\n \"create_date\": \"2024-12-10 15:31:26\",\r\n \"created_by\": 4680,\r\n \"edit_date\": null,\r\n \"edited_by\": null\r\n },\r\n {\r\n \"id\": 1078,\r\n \"channel_id\": 2191,\r\n \"collection_id\": 806,\r\n \"name\": \"cards\",\r\n \"category\": \"utility\",\r\n \"status\": \"pending\",\r\n \"language\": \"en\",\r\n \"header_type\": null,\r\n \"header_text\": null,\r\n \"header_attachment_id\": null,\r\n \"header_example_text_param\": null,\r\n \"header_example_media_url\": null,\r\n \"text\": \"Your card is locked. Contact our support for details.\",\r\n \"text_example_params\": null,\r\n \"footer\": \"Regards.\",\r\n \"buttons\": [\r\n {\r\n \"text\": \"Call us\",\r\n \"type\": \"phone\",\r\n \"phone\": \"+47421115566\"\r\n },\r\n {\r\n \"url\": \"https://google.com\",\r\n \"text\": \"Vist our website\",\r\n \"type\": \"url\",\r\n \"url_postfix\": \"{{d}}\"\r\n }\r\n ],\r\n \"button_example_url_text\": \"https://google.com/серж\",\r\n \"external_id\": 109973,\r\n \"create_date\": \"2024-12-10 14:14:20\",\r\n \"created_by\": 4680,\r\n \"edit_date\": \"2024-12-10 14:14:42\",\r\n \"edited_by\": 4680\r\n }\r\n ],\r\n \"_meta\": {\r\n \"totalCount\": 3,\r\n \"pageCount\": 1,\r\n \"currentPage\": 1,\r\n \"perPage\": 20\r\n }\r\n}"}],"_postman_id":"29c90d95-c06f-4cef-a021-4810194ca8b3"}],"id":"bd49f88e-6e35-46cb-b29e-04837184106c","description":"This folder contains actions you may need to find specific WhatsApp HSM templates.
\nA WhatsApp HSM template (Highly Structured Message) is a pre-defined standard message for sending to customers via WhatsApp.
\n","_postman_id":"bd49f88e-6e35-46cb-b29e-04837184106c"},{"name":"wrapUpCodes","item":[{"name":"createWrapUpCodesSet","id":"ddaa058a-437a-4440-98c1-7d79fd28b80e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"title","value":"РекламаМебели3","type":"text","description":"String. Required.
\nThe wrap-up codes set name.
\n"},{"key":"description","value":"Мебель","type":"text","description":"String. Optional.
\nThe wrap-up codes set description. The maximum number of symbols is 255.
\n"},{"key":"codes","value":"[{\"title\":\"Declined\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Do not call any more\", \"type\":\"do_not_call\", \"order\":2}]","type":"text","description":"JSON array. Optional.
\nThe wrap-up codes you want to add to the set. Each wrap-up code contains a title, type (callback, do_not_call, closure_success, closure_neutral, amd, closure_negative), and sequence order.
\nExample: [{\"title\":\"Declined\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Do not call any more\", \"type\":\"do_not_call\", \"order\":2}]
\n"}]},"url":"https://{{host}}/api/v3/wrapup/createWrapUpCodesSet?domain={{domain}}","description":"Creates a wrap-up codes set.
\n","urlObject":{"protocol":"https","path":["api","v3","wrapup","createWrapUpCodesSet"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"64ac5bd9-1d9e-4092-a86b-ba62dc0c0138","name":"createWrapUpCodesSet","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text"},{"key":"title","value":"РекламаМебели3","type":"text"},{"key":"description","value":"Мебель","type":"text"},{"key":"codes","value":"[{\"title\":\"Отклонили\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Не звонить больше\", \"type\":\"do_not_call\", \"order\":2}]","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/wrapup/createWrapUpCodesSet?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","wrapup","createWrapUpCodesSet"],"query":[{"key":"domain","value":"{{domain}}"},{"key":"access_token","value":"{{access_token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"ddaa058a-437a-4440-98c1-7d79fd28b80e"},{"name":"updateWrapUpCodesSet","id":"34497845-ccdb-47d1-9fb0-9de1f525c6d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"292","type":"text","description":"Integer. Required.
\nThe ID of the wrap-up codes set you want to update. Use the searchWrapUpCodesSet method to retreive the list of available set IDs.
\n"},{"key":"title","value":"Results","type":"text","description":"String. Optional.
\nThe name of the wrap-up codes set.
\n"},{"key":"description","value":"Call results","type":"text","description":"String. Optional.
\nThe wrap-up codes set description. The maximum number of symbols is 255.
\n"},{"key":"codes","value":"Example: [{\"title\":\"Declined\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Do not call any more\", \"type\":\"do_not_call\", \"order\":2}]","type":"text","description":"JSON array. Optional.
\nThe wrap-up codes within the set. Each wrap-up code contains a title, type (callback, do_not_call, closure_success, closure_neutral, amd, closure_negative), and sequence order.
\nExample: [{\"title\":\"Declined\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Do not call any more\", \"type\":\"do_not_call\", \"order\":2}]
\n"}]},"url":"https://{{host}}/api/v3/wrapup/updateWrapUpCodesSet?domain={{domain}}","description":"Updates a wrap-up codes set.
\n","urlObject":{"protocol":"https","path":["api","v3","wrapup","updateWrapUpCodesSet"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"a85630b0-f7fe-47b9-a69e-e9cea619c927","name":"updateWrapUpCodesSet","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"292","type":"text","description":"Integer. Required.\n\nThe ID of the wrap-up codes set you want to update. Use the searchWrapUpCodesSet method to retreive the list of available set IDs."},{"key":"title","value":"Results","type":"text","description":"String. Optional.\n\nThe name of the wrap-up codes set."},{"key":"description","value":"Call results","type":"text","description":"String. Optional.\n\nThe wrap-up codes set description. The maximum number of symbols is 255."},{"key":"codes","value":"Example: [{\"title\":\"Declined\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Do not call any more\", \"type\":\"do_not_call\", \"order\":2}]","type":"text","description":"JSON array. Optional.\n\nThe wrap-up codes within the set. Each wrap-up code contains a title, type (callback, do_not_call, ДИМА какие еще??), and sequence order.\n\nExample: [{\"title\":\"Declined\", \"type\":\"callback\", \"order\":1}, {\"title\":\"Do not call any more\", \"type\":\"do_not_call\", \"order\":2}]"}]},"url":{"raw":"https://{{host}}/api/v3/wrapup/updateWrapUpCodesSet?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","wrapup","updateWrapUpCodesSet"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": true\n}"}],"_postman_id":"34497845-ccdb-47d1-9fb0-9de1f525c6d8"},{"name":"searchWrapUpCodesSets","id":"f324e621-84d0-41d8-b1f9-a15919064ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"5","type":"text","description":"Integer. Optional.
\nThe particular wrap-up codes set ID to filter.
\n","disabled":true},{"key":"title","value":"Results","type":"text","description":"String. Optional.
\nThe particular wrap-up codes set name to filter.
\n","disabled":true},{"key":"with_codes","value":"true","type":"text","description":"Boolean. Optional.
\nSpecifies whether the response should include wrap-up codes contained in the set. The options are true|false.
\n"},{"key":"with_agent_campaigns","value":"true","description":"Boolean. Optional.
\nSpecifies whether the response should include agent campaigns that use wrap-up codes sets. The options are true|false.
\n","type":"text"}]},"url":"https://{{host}}/api/v3/wrapup/searchWrapUpCodesSets?domain={{domain}}","description":"Retrieves a list of wrap-up codes sets.
\nIf you define specific query parameters, the request retrieves only the results that match those parameters.
\n","urlObject":{"protocol":"https","path":["api","v3","wrapup","searchWrapUpCodesSets"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"d9b3cd95-8626-4232-ae55-b9ba94ece831","name":"searchWrapUpCodesSets","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"0ca12de62c9d2e4d6020907f6ea96a3f9180dbb353cdbeeb10aa05d171ea8018","type":"text"},{"key":"id","value":"5","type":"text","disabled":true},{"key":"title","value":"меб","type":"text","disabled":true},{"key":"with_codes","value":"1","type":"text"},{"key":"with_agent_campaigns","value":"true","description":"bool","type":"text"}]},"url":{"raw":"https://{{host}}/api/v3/wrapup/searchWrapUpCodesSets?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","wrapup","searchWrapUpCodesSets"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"result\": [\n {\n \"id\": 750,\n \"title\": \"Set 1\",\n \"description\": \"\",\n \"codes_count\": 1,\n \"is_contains_dnc_code\": false,\n \"create_date\": \"2025-02-25 13:25:08\",\n \"created_by\": 4651,\n \"edited_by\": null,\n \"edit_date\": null,\n \"codes\": [\n {\n \"id\": 1425,\n \"title\": \"Callback\",\n \"type\": \"callback\",\n \"order\": 1\n }\n ],\n \"agent_campaigns\": []\n },\n {\n \"id\": 756,\n \"title\": \"Do not call\",\n \"description\": \"\",\n \"codes_count\": 3,\n \"is_contains_dnc_code\": false,\n \"create_date\": \"2025-03-04 07:01:36\",\n \"created_by\": 4651,\n \"edited_by\": 4651,\n \"edit_date\": \"2025-10-21 08:21:07\",\n \"codes\": [\n {\n \"id\": 1476,\n \"title\": \"No callback required\",\n \"type\": \"closure_negative\",\n \"order\": 1\n },\n {\n \"id\": 1874,\n \"title\": \"0\",\n \"type\": \"callback\",\n \"order\": 3\n },\n {\n \"id\": 1873,\n \"title\": \"1\",\n \"type\": \"closure_neutral\",\n \"order\": 2\n }\n ],\n \"agent_campaigns\": []\n }\n ],\n \"_meta\": {\n \"totalCount\": 3,\n \"pageCount\": 1,\n \"currentPage\": 1,\n \"perPage\": 20\n }\n}"}],"_postman_id":"f324e621-84d0-41d8-b1f9-a15919064ed9"},{"name":"deleteWrapUpCodesSet","id":"1922fc62-fa2f-4bb0-abfc-a228422f1068","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.
\nYour API token.
\n"},{"key":"id","value":"33","type":"text","description":"Integer. Required.
\nThe ID of the wrap-up codes set you want to delete.
\n"}]},"url":"https://{{host}}/api/v3/wrapup/deleteWrapUpCodesSet?domain={{domain}}","description":"Deletes a wrap-up codes set.
\n","urlObject":{"protocol":"https","path":["api","v3","wrapup","deleteWrapUpCodesSet"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"}],"variable":[]}},"response":[{"id":"89ba1d82-8825-4c8d-bb30-4f2293d3b68e","name":"deleteWrapUpCodesSet","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"access_token","value":"{{access_token}}","type":"text","description":"String. Required.\n\nYour API token."},{"key":"id","value":"33","type":"text","description":"Integer. Required.\n\nThe ID of the wrap-up codes set you want to delete."}]},"url":{"raw":"https://{{host}}/api/v3/wrapup/deleteWrapUpCodesSet?domain={{domain}}","protocol":"https","host":["{{host}}"],"path":["api","v3","wrapup","deleteWrapUpCodesSet"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"1922fc62-fa2f-4bb0-abfc-a228422f1068"}],"id":"243c0973-1a3b-4a1e-b3e0-57d313cc8ffd","description":"This folder contains actions you may need to manage wrap-up codes sets.
\nA wrap-up code is a code that allows agents to mark the result of calls made in agent campaigns. Wrap-up codes are grouped into a set. After you create a set of wrap-up codes, it becomes available for agents in their Workspace.
\n","_postman_id":"243c0973-1a3b-4a1e-b3e0-57d313cc8ffd"},{"name":"bulkMessaging","item":[{"name":"appendContacts","id":"612c1a98-8f0a-4a11-a7db-49b80ac3216a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"rows","value":"[{\"phone\":\"+12025550123\",\"head1\":\"John Smith\",\"timezone\":\"+2\",\"text1\":\"Order update\",\"text2\":\"Your order is ready\"},{\"phone\":\"+12025550124\",\"head1\":\"Mary Johnson\",\"timezone\":\"+2\",\"text1\":\"Delivery update\",\"text2\":\"Your package is on the way\"}]","type":"text","description":"Array. Required.
\nContact rows to add to the WhatsApp bulk message. Each array item represents one contact and should contain the contact phone number, timezone, and values for the variables used in the selected WhatsApp HSM template. Template variable fields are required if the selected template uses variables. Variable field names, such as head1, text1, and text2, depend on the selected template.
Integer. Required.
\nID of the WhatsApp bulk message to add contacts to. Use the search method to retrieve available bulk message IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessagingContacts/appendContacts?domain={{domain}}&access_token={{access_token}}","description":"Adds contacts to a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessagingContacts","appendContacts"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"14804c84-f5d3-4c31-8ad2-4872293ff7c2","name":"appendContacts","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"rows","value":"[{\"phone\":\"+12025550123\",\"head1\":\"John Smith\",\"timezone\":\"+2\",\"text1\":\"Order update\",\"text2\":\"Your order is ready\"},{\"phone\":\"+12025550124\",\"head1\":\"Mary Johnson\",\"timezone\":\"+2\",\"text1\":\"Delivery update\",\"text2\":\"Your package is on the way\"}]","type":"text","description":"Array. Required.\n\nContact rows."},{"key":"bulk_messaging_id","value":"5","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessagingContacts/appendContacts?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessagingContacts","appendContacts"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": {\r\n \"success_contacts\": 1,\r\n \"failed_contacts\": 1,\r\n \"total_contacts\": 2,\r\n \"invalid_phones\": [\r\n {\r\n \"head1\": \"John Smith\",\r\n \"phone\": \"+1202555012345\",\r\n \"text1\": \"Order status update\",\r\n \"text2\": \"Your order is ready\",\r\n \"timezone\": \"+2\"\r\n }\r\n ],\r\n \"invalid_tz\": null,\r\n \"invalid_variables\": null\r\n }\r\n}"}],"_postman_id":"612c1a98-8f0a-4a11-a7db-49b80ac3216a"},{"name":"cancelLists","id":"5633852c-c7a1-4db1-9774-761aa2370c47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"bulk_messaging_id","value":"9","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message whose lists you want to cancel. Use the search method to retrieve available bulk message IDs.
\n"},{"key":"list_ids","value":"[783, 778]","type":"text","description":"Array. Required.
\nIDs of the contact lists to cancel in the specified WhatsApp bulk message. These are list IDs, not bulk message IDs. The value must be an array of list IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/cancelLists?domain={{domain}}&access_token={{access_token}}","description":"Cancels WhatsApp bulk message lists.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","cancelLists"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"c186379f-13e3-42a2-81ff-c00c3ef1d486","name":"cancelLists","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"bulk_messaging_id","value":"9","type":"text","description":"Integer. Required.\n\nBulk message ID."},{"key":"list_ids","value":"[783, 778]","type":"text","description":"Array. Required.\n\nBulk message list IDs."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/cancelLists?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","cancelLists"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"5633852c-c7a1-4db1-9774-761aa2370c47"},{"name":"complete","id":"cad25007-1842-4ec2-b8f3-62a7a6f0fbf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message you want to complete. Use the search method to retrieve available bulk message IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/complete?domain={{domain}}&access_token={{access_token}}","description":"Completes a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","complete"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"d5ed825a-18c6-4ac7-ac48-18f13b031f1d","name":"complete","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/complete?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","complete"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"cad25007-1842-4ec2-b8f3-62a7a6f0fbf6"},{"name":"create","id":"70ce9df0-ca33-434b-85f3-dec928689648","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"test","type":"text","description":"String. Required.
\nBulk message title. The value must be unique among non-deleted bulk messages in the account. The maximum length is 140 characters.
\n"},{"key":"planned_date_start","value":"{{currentDate}}","type":"text","description":"String. Optional.
\nBulk message start date in the yyyy-MM-dd HH:mm:ss format. The default value is null.
\n"},{"key":"planned_date_end","value":"{{afterTenDays}}","type":"text","description":"String. Optional.
\nBulk message end date in the yyyy-MM-dd HH:mm:ss format. The default value is null.
\n"},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"Array. Optional.
\nTime range when the bulk message is sent. The value must contain 2 time values in the HH:mm format. The minimum difference between the values is 1 minute. The default value is null.
\n"},{"key":"channel_id","value":"43","type":"text","description":"Integer. Required.
\nWhatsApp channel ID. The channel must have at least 1 approved template.
\n"},{"key":"whatsapp_hsm_template_id","value":"23","type":"text","description":"Integer. Required.
\nWhatsApp HSM template ID. The template must be linked to the specified channel and approved.
\n"},{"key":"use_marketing_messages_api","value":"true","type":"text","description":"Boolean. Optional.
\nWhether to use Marketing Messages API. The default value is true.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/create?domain={{domain}}&access_token={{access_token}}","description":"Creates a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","create"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"6326fe41-3077-4e03-bcc7-ed0a5e0330a3","name":"create","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"test","type":"text","description":"String. Required.\n\nBulk message title. The value must be unique among non-deleted bulk messages in the account. The maximum length is 140 characters."},{"key":"planned_date_start","value":"{{currentDate}}","type":"text","description":"String. Optional.\n\nBulk message start date in the yyyy-MM-dd HH:mm:ss format. The default value is null."},{"key":"planned_date_end","value":"{{afterTenDays}}","type":"text","description":"String. Optional.\n\nBulk message end date in the yyyy-MM-dd HH:mm:ss format. The default value is null."},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"Array. Optional.\n\nTime range when the bulk message is sent. The value must contain 2 time values in the HH:mm format. The minimum difference between the values is 1 minute. The default value is null."},{"key":"channel_id","value":"43","type":"text","description":"Integer. Required.\n\nWhatsApp channel ID. The channel must have at least 1 approved template."},{"key":"whatsapp_hsm_template_id","value":"23","type":"text","description":"Integer. Required.\n\nWhatsApp HSM template ID. The template must be linked to the specified channel and approved."},{"key":"use_marketing_messages_api","value":"true","type":"text","description":"Boolean. Optional.\n\nWhether to use Marketing Messages API. The default value is true."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/create?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","create"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": {\r\n \"id\": 1084,\r\n \"title\": \"Order status update\",\r\n \"status\": \"draft\",\r\n \"status_time\": null,\r\n \"planned_date_start\": null,\r\n \"planned_date_end\": null,\r\n \"working_time\": null,\r\n \"date_start\": null,\r\n \"date_end\": null,\r\n \"channel_id\": 2767,\r\n \"whatsapp_hsm_template_id\": 1992,\r\n \"use_marketing_messages_api\": true,\r\n \"total_contacts\": null,\r\n \"folder_id\": null,\r\n \"create_date\": \"2026-05-07 16:06:38\",\r\n \"created_by\": 19777,\r\n \"edit_date\": null,\r\n \"edited_by\": null\r\n }\r\n}"}],"_postman_id":"70ce9df0-ca33-434b-85f3-dec928689648"},{"name":"delete","id":"c4ad30cb-2ef1-4ed9-9588-2545be629eff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"2","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message you want to delete. Use the search method to retrieve available bulk message IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/delete?domain={{domain}}&access_token={{access_token}}","description":"Deletes a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","delete"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"57b0b3da-95ef-4ccb-89b8-5b572ba12051","name":"delete","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"2","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/delete?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","delete"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"c4ad30cb-2ef1-4ed9-9588-2545be629eff"},{"name":"deleteLists","id":"af73e0dd-8448-474d-a705-b76cb8474653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"bulk_messaging_id","value":"4","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message whose lists you want to delete. Use the search method to retrieve available bulk message IDs.
\n"},{"key":"list_ids","value":"[3, 9]","type":"text","description":"Array. Required.
\nIDs of the contact lists you want to delete in the specified WhatsApp bulk message. These are list IDs, not bulk message IDs. The value must be an array of list IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/deleteLists?domain={{domain}}&access_token={{access_token}}","description":"Deletes WhatsApp bulk message lists.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","deleteLists"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"86f3447a-c82c-4ef9-bc04-34ccb0f3a75b","name":"deleteLists","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"bulk_messaging_id","value":"4","type":"text","description":"Integer. Required.\n\nBulk message ID."},{"key":"list_ids","value":"[3, 9]","type":"text","description":"Array. Required.\n\nBulk message list IDs."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/deleteLists?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","deleteLists"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"af73e0dd-8448-474d-a705-b76cb8474653"},{"name":"pause","id":"8121d872-7a50-4369-8343-09525743038a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nBulk message ID.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/pause?domain={{domain}}&access_token={{access_token}}","description":"Pauses a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","pause"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"555b6f89-43f8-41c6-a4af-078512918def","name":"pause","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/pause?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","pause"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"8121d872-7a50-4369-8343-09525743038a"},{"name":"resume","id":"99d07ba1-370f-45bf-8cc3-1007f3bb90ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message you want to pause. Use the search method to retrieve available bulk message IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/resume?domain={{domain}}&access_token={{access_token}}","description":"Resumes a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","resume"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"d57b4cdc-fbf9-47a8-be04-8e71f2247e8a","name":"resume","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/resume?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","resume"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"99d07ba1-370f-45bf-8cc3-1007f3bb90ea"},{"name":"schedule","id":"3a75e9a9-bb88-45ec-a075-e9cb162f812c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message you want to schedule. Use the search method to retrieve available bulk message IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/schedule?domain={{domain}}&access_token={{access_token}}","description":"Schedules a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","schedule"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"22d7db6f-9f54-4f9f-a94e-6ef76354040c","name":"schedule","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/schedule?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","schedule"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"3a75e9a9-bb88-45ec-a075-e9cb162f812c"},{"name":"search","id":"770944ee-69f2-41d4-be9a-24347ea4440f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"ids","value":"[1,2,9,27]","type":"text","description":"Array. Optional.
\nIDs of the WhatsApp bulk messages to search for. Use this parameter to filter the search results by one or more bulk message IDs.
\n"},{"key":"statuses","value":"[\"ongoing\", \"completed\"]","type":"text","description":"Array. Optional.
\nStatuses of the WhatsApp bulk messages to search for. Use this parameter to filter the search results by one or more bulk message statuses.
\n"},{"key":"channel_ids","value":"[1,2]","type":"text","description":"Array. Optional.
\nIDs of the WhatsApp channels used in the bulk messages. Use this parameter to filter the search results by one or more WhatsApp channel IDs.
\n"},{"key":"title","value":"Order status update","type":"text","description":"String. Optional.
\nBulk message title. The maximum length is 140 characters.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/search?domain={{domain}}&access_token={{access_token}}","description":"Searches for WhatsApp bulk messages.
\nThis method searches the bulk message entities, not individual WhatsApp messages sent to contacts.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","search"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"d13f74cc-92e2-4d09-8921-ce0881032c57","name":"search","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"ids","value":"[1,2,9,27]","type":"text","description":"Array. Optional.\n\nBulk message IDs."},{"key":"statuses","value":"[\"ongoing\", \"completed\"]","type":"text","description":"Array. Optional.\n\nBulk message statuses."},{"key":"channel_ids","value":"[1,2]","type":"text","description":"Array. Optional.\n\nWhatsApp channel IDs."},{"key":"title","value":"Order status update","type":"text","description":"String. Optional.\n\nBulk message title. The maximum length is 140 characters."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/search?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","search"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": [\r\n {\r\n \"id\": 1067,\r\n \"domain_id\": 929,\r\n \"channel_id\": 2767,\r\n \"whatsapp_hsm_template_id\": 2123,\r\n \"use_marketing_messages_api\": true,\r\n \"title\": \"Order status update\",\r\n \"planned_date_start\": null,\r\n \"planned_date_end\": null,\r\n \"working_time\": null,\r\n \"date_start\": null,\r\n \"date_end\": null,\r\n \"status\": \"draft\",\r\n \"status_time\": null,\r\n \"total_contacts\": null,\r\n \"create_date\": \"2026-04-30 08:02:48\",\r\n \"created_by\": 4453,\r\n \"edit_date\": null,\r\n \"edited_by\": null,\r\n \"stop_reason\": null,\r\n \"folder_id\": null\r\n }\r\n ],\r\n \"_meta\": {\r\n \"limit\": 50,\r\n \"cursor\": null\r\n }\r\n}"}],"_postman_id":"770944ee-69f2-41d4-be9a-24347ea4440f"},{"name":"start","id":"583a27a4-26ca-4e19-a43c-548150fbb2ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message you want to start. Use the search method to retrieve available bulk message IDs.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/start?domain={{domain}}&access_token={{access_token}}","description":"Starts a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","start"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"716183f8-fe04-4bec-bc67-95c6d659b731","name":"start","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text","description":"Integer. Required.\n\nBulk message ID."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/start?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","start"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": true\r\n}"}],"_postman_id":"583a27a4-26ca-4e19-a43c-548150fbb2ed"},{"name":"update","id":"b97571b2-c294-4afc-9528-37afe668fc68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"5","type":"text","description":"Integer. Required.
\nID of the WhatsApp bulk message you want to update. Use the search method to retrieve available bulk message IDs.
\n"},{"key":"title","value":"test","type":"text","description":"String. Optional.
\nBulk message title. The value must be unique among non-deleted bulk messages in the account. The maximum length is 140 characters.
\n"},{"key":"planned_date_start","value":"{{currentDate}}","type":"text","description":"String. Optional.
\nBulk message start date in the yyyy-MM-dd HH:mm:ss format. Send an empty string to set the value to null.
\n"},{"key":"planned_date_end","value":"{{afterTenDays}}","type":"text","description":"String. Optional.
\nBulk message end date in the yyyy-MM-dd HH:mm:ss format. Send an empty string to set the value to null.
\n"},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"Array. Optional.
\nTime range when the bulk message is sent. The value must contain 2 time values in the HH:mm format. The minimum difference between the values is 1 minute. Send an empty string to set the value to null.
\n"},{"key":"channel_id","value":"43","type":"text","description":"Integer. Optional.
\nWhatsApp channel ID. The channel must have at least 1 approved template.
\n"},{"key":"whatsapp_hsm_template_id","value":"23","type":"text","description":"Integer. Optional.
\nWhatsApp HSM template ID. The template must be linked to the specified channel and approved.
\n"},{"key":"use_marketing_messages_api","value":"true","type":"text","description":"Boolean. Optional.
\nWhether to use Marketing Messages API for the WhatsApp bulk message.
\n"}]},"url":"https://{{host}}/api/v3/bulkMessaging/update?domain={{domain}}&access_token={{access_token}}","description":"Updates a WhatsApp bulk message.
\n","urlObject":{"protocol":"https","path":["api","v3","bulkMessaging","update"],"host":["{{host}}"],"query":[{"description":{"content":"String. Required.
\nYour account name.
\n","type":"text/plain"},"key":"domain","value":"{{domain}}"},{"description":{"content":"String. Required.
\nYour API token.
\n","type":"text/plain"},"key":"access_token","value":"{{access_token}}"}],"variable":[]}},"response":[{"id":"81001497-c8cb-44f2-93d0-9989a1534db3","name":"update","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"5","type":"text","description":"Integer. Required.\n\nBulk message ID."},{"key":"title","value":"test","type":"text","description":"String. Optional.\n\nBulk message title. The value must be unique among non-deleted bulk messages in the account. The maximum length is 140 characters."},{"key":"planned_date_start","value":"{{currentDate}}","type":"text","description":"String. Optional.\n\nBulk message start date in the yyyy-MM-dd HH:mm:ss format. Send an empty string to set the value to null."},{"key":"planned_date_end","value":"{{afterTenDays}}","type":"text","description":"String. Optional.\n\nBulk message end date in the yyyy-MM-dd HH:mm:ss format. Send an empty string to set the value to null."},{"key":"working_time","value":"[\"11:35\", \"19:00\"]","type":"text","description":"Array. Optional.\n\nTime range when the bulk message is sent. The value must contain 2 time values in the HH:mm format. The minimum difference between the values is 1 minute. Send an empty string to set the value to null."},{"key":"channel_id","value":"43","type":"text","description":"Integer. Optional.\n\nWhatsApp channel ID. The channel must have at least 1 approved template."},{"key":"whatsapp_hsm_template_id","value":"23","type":"text","description":"Integer. Optional.\n\nWhatsApp HSM template ID. The template must be linked to the specified channel and approved."},{"key":"use_marketing_messages_api","value":"true","type":"text","description":"Boolean. Optional.\n\nWhether to use Marketing Messages API."}]},"url":{"raw":"https://{{host}}/api/v3/bulkMessaging/update?domain={{domain}}&access_token={{access_token}}","protocol":"https","host":["{{host}}"],"path":["api","v3","bulkMessaging","update"],"query":[{"key":"domain","value":"{{domain}}","description":"String. Required.\n\nYour account name."},{"key":"access_token","value":"{{access_token}}","description":"String. Required.\n\nYour API token."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"result\": {\r\n \"id\": 1071,\r\n \"title\": \"Order status update\",\r\n \"status\": \"draft\",\r\n \"status_time\": null,\r\n \"planned_date_start\": null,\r\n \"planned_date_end\": null,\r\n \"working_time\": null,\r\n \"date_start\": null,\r\n \"date_end\": null,\r\n \"channel_id\": 3924,\r\n \"whatsapp_hsm_template_id\": 2456,\r\n \"use_marketing_messages_api\": true,\r\n \"total_contacts\": 2,\r\n \"folder_id\": null,\r\n \"create_date\": \"2026-05-04 10:51:19\",\r\n \"created_by\": 6399,\r\n \"edit_date\": \"2026-05-07 10:15:08\",\r\n \"edited_by\": 4680\r\n }\r\n}"}],"_postman_id":"b97571b2-c294-4afc-9528-37afe668fc68"}],"id":"ecb7483b-57a0-4654-8311-e69e98bafaa5","description":"This folder contains methods for creating, updating, searching, and managing WhatsApp bulk messages and their lists.
\nA WhatsApp bulk message is a mass message sent to multiple customers via WhatsApp.
\n","_postman_id":"ecb7483b-57a0-4654-8311-e69e98bafaa5"}]}