<... callid="">

 

Type

attribute

Elements

campaign | phonenumber | prompt

Data type

char[50]

Values

alphanumeric

Description

Sending calls:

Optional user defined value to track a calls.  In practice, this value many times corresponds to a unique identifier, or GUID, set by the sender in order to associate a calls with their internal data.  Also used for Call Queries.  If the same callid is used for more than one call, it creates a call group.  Call Querying that callid will retrieve call information for the group.

 

Receiving Calls

Call Events are asynchronous.  Use callid to distinguish between Call Events from different calls.  A callid will be set on the answer Call Event and cleared on the hang-up Call Event.

 

Example 1: Sending a call to two phone numbers

<campaign menuid="1-1234" action="0">

   <prompts>

      <prompt promptid="2" tts="Web server 5 is down." />

   </prompts>

   <phonenumbers>

      <phonenumber number="8185550100" callid="123abc" callerid="8182238964" />

      <phonenumber number="8185550101" callid="456def" callerid="8182238964" />

   </phonenumbers>

</campaign>

 

Example 2: Call Query results for callid 123abc

<campaign action="3" menuid="1-1234">

   <phonenumbers>

      <phonenumber callid="123abc" />

   </phonenumbers>

</campaign> 

 

Example 3: Setting no callid for a Call Query retrieves results for all calls

<campaign action="3" menuid="1-1234">

   <phonenumbers>

      <phonenumber callid="" />

   </phonenumbers>

</campaign> 

 

Examples 4 - 6 show Call Events for a single call.  Use callid to distinguish between different calls occurring at the same time.

 

Example 4: Connect Call Event

<campaign menuid="1-3" callid="213167" action="4" callerid="8182238964"/> 

 

Example 5: Key press Call Event

<prompt menuid="1-3" callid="213167" promptid="2" keypress="10000000"/>

 

Example 6: Disconnect Call Event

<campaign menuid="1-3" callid="213167" action="5" duration="24"/>