Naar navigatie springen
API-referentieCampagnes

Een uitgaande campagne maken

Maak een uitgaande campagne die elke ontvanger met de agent belt of berichten stuurt, binnen de belvensters van het beleid, met nieuwe pogingen en follow-ups voor zover toegestaan. Retourneert 201 voor een nieuwe campagne. Een herhaald request, gekoppeld via idempotency_key of anders via de body, retourneert de bestaande campagne met created op false.

Headers

xi-api-keystringOptioneel

Verzoek

This endpoint expects an object.
call_namestringVerplicht1-256 characters
De naam van de campagne.
agent_idstringVerplicht1-256 characters
De agent die de oproepen plaatst.
recipientslist of objectsVerplicht
Wie je moet bellen. Elke ontvanger wordt een lead van de campagne.
channel_configobjectVerplicht
scheduled_time_unixintegerOptioneel>=0

Wanneer je moet beginnen met bellen; laat weg om nu te starten. Oproepen wachten nog steeds op het volgende belvenster.

timezonestringOptioneel

IANA-tijdzone waarin de belvensters worden geïnterpreteerd, die die van het beleid overschrijft.

branch_idstringOptioneel<=256 characters
De agentbranch waarmee moet worden gebeld.
environmentstringOptioneel<=256 characters
De omgeving waarin de omgevingsvariabelen van de agent moeten worden opgelost.
target_concurrency_limitintegerOptioneel>=1
Het maximale aantal oproepen dat tegelijk wordt geplaatst.
idempotency_keystringOptioneel1-256 characters

Maakt het request veilig om opnieuw te proberen: een herhaling met dezelfde sleutel retourneert de campagne die ermee is gemaakt.

outcomeobjectOptioneel
Het resultaat dat als succes geldt voor de oproepen van de campagne.
policyobjectOptioneel

Beleid dat als momentopname aan de campagne wordt gekoppeld. Wanneer het is ingesteld, heeft het voorrang op de workspacestandaard en eventuele overschrijvingen per agent; wanneer het wordt weggelaten, moet de workspaceconfiguratie bestaan en levert die het beleid.

variantenumOptioneel

simple voert één poging per ontvanger uit met doorlopende belvensters en zonder gegevensverzameling, en kan niet worden gecombineerd met policy. advanced gebruikt policy of de workspaceconfiguratie en is de standaardinstelling voor telefooncampagnes.

Toegestane waarden:

Response

Geslaagde response
campaignobject
createdboolean
False wanneer het request een eerder request herhaalde en de bijbehorende campagne retourneerde.
within_calling_windowboolean
Of het bellen direct begint in plaats van in het volgende belvenster.

Fouten

422
Outbound Campaigns Create Request Unprocessable Entity Error