नेविगेशन पर जाएँ

आउटबाउंड कैंपेन बनाएं

एक आउटबाउंड अभियान बनाएं, जो पॉलिसी की कॉलिंग विंडो के भीतर एजेंट के ज़रिए हर प्राप्तकर्ता को कॉल या मैसेज करे, और अनुमति के अनुसार रीट्राई व फ़ॉलो-अप करे। नए अभियान के लिए 201 लौटाता है। idempotency_key या अनुरोध बॉडी से मेल खाने वाला दोहराया गया अनुरोध, created को false के साथ मौजूदा अभियान लौटाता है।

हेडर

xi-api-keystringवैकल्पिक

अनुरोध

This endpoint expects an object.
call_namestringआवश्यक1-256 characters

अभियान का नाम।

agent_idstringआवश्यक1-256 characters

कॉल करने वाला एजेंट।

recipientslist of objectsआवश्यक

किसे कॉल करना है। हर प्राप्तकर्ता कैंपेन की एक लीड बन जाता है।

channel_configobjectआवश्यक
scheduled_time_unixinteger or nullवैकल्पिक>=0

कॉल करना कब शुरू करें; अभी शुरू करने के लिए इसे छोड़ दें। कॉल्स फिर भी अगले कॉलिंग विंडो का इंतज़ार करती हैं।

timezonestring or nullवैकल्पिक

कॉलिंग विंडो पढ़ने के लिए IANA टाइमज़ोन, जो पॉलिसी वाले टाइमज़ोन को ओवरराइड करता है।

branch_idstring or nullवैकल्पिक<=256 characters

कॉल करने के लिए एजेंट ब्रांच।

environmentstring or nullवैकल्पिक<=256 characters

एजेंट के एनवायरनमेंट वैरिएबल रिज़ॉल्व करने का एनवायरनमेंट।

target_concurrency_limitinteger or nullवैकल्पिक>=1

एक साथ की जाने वाली अधिकतम कॉल।

idempotency_keystring or nullवैकल्पिक1-256 characters

अनुरोध को रीट्राई के लिए सुरक्षित बनाता है: उसी कुंजी के साथ दोहराने पर उसके द्वारा बनाया गया अभियान लौटता है।

outcomeobject or nullवैकल्पिक

वह परिणाम जिसे कैंपेन की कॉल के लिए सफलता माना जाता है।

policyobject or nullवैकल्पिक

अभियान पर स्नैपशॉट करने के लिए पॉलिसी। सेट होने पर यह वर्कस्पेस डिफ़ॉल्ट और किसी भी प्रति-एजेंट ओवरराइड पर प्राथमिकता पाती है; छोड़ने पर वर्कस्पेस कॉन्फ़िगरेशन मौजूद होना चाहिए और वही पॉलिसी देता है।

variantenum or nullवैकल्पिक

simple हर प्राप्तकर्ता के लिए हमेशा खुले कॉलिंग विंडो के साथ एक प्रयास चलाता है और कोई डेटा एकत्र नहीं करता; इसे policy के साथ नहीं जोड़ा जा सकता। advanced, policy या वर्कस्पेस कॉन्फ़िगरेशन का उपयोग करता है और फ़ोन अभियानों के लिए डिफ़ॉल्ट है।

अनुमत मान:

रिस्पॉन्स

सफल रिस्पॉन्स

campaignobject
createdboolean

जब अनुरोध पहले वाले अनुरोध की पुनरावृत्ति हो और उसका अभियान लौटाए, तब false।

within_calling_windowboolean

क्या कॉलिंग अगली कॉलिंग विंडो के बजाय तुरंत शुरू होती है।

त्रुटियाँ

422
Unprocessable Entity Error