Ipcom webservices2

IPCOM Network

Web Services

2012©

Protocol Description IPCOM Web Services allows clients' applications to securely connect directly to the IPCOM Application/Web Server and submit transaction data. The client will initiate all requests. The client submits the data in one of the two ways Https-Post or Https-Get. The Https Post/Get must consist of a set of fields that are required for each transaction, and a set of fields that are optional. The Client has the option of sending the configuration of the response on a per-transaction basis or using the default settings. The server responds a Name/Value pairs according to the client configuration. The 'Name' is the field name and indicates what information is being submitted and the 'Value' contains the content of the field. To implement, a developer would design a script that does the following: 1. Obtains all of the information needed to process a transaction. 2. Initiates Post/Get from their server to https://ws.ip-com.com/ 3. Receives the response from the gateway and processes the response to display the appropriate result to the end user. Please do not forget to contact IPCOM to get a web services login account and details when you are ready for development. The next section describes the possible transaction types and details of the each request and the response.

IPCOM NETWORKS © 2010

March 20, 2013 <index> 3

Standard Transaction Submission

The following tables contain the data fields that may be submitted to the system with any type of transaction. Each table contains the following information:

• Field Name – Name of the parameter that may be submitted on a transaction. • Required – Indicates whether the field is required on a transaction. If Conditional, indicates that the field is required based on the existence or value of another field. In cases where a dependency exists, an explanation is provided. • Field Type – Shows the data type and the data length for the field. • Description – Provides additional details on how the field is used.

Field Name Required Field Type Description

transaction_type Yes Integer Constant value (Transaction Type Codes) user_id Yes String (20) Unique identifier to each client to access the

Web Service. IPCOM will provide this identifier to the client.

user_pw Yes String (20) Password for the user_id. IPCOM will provide this identifier to the client.

field_delimeter No String (2) Characters that will be used to separate fields in the transaction response. The system will use the character passed in this field or '&' as default if no value is passed. * This option is not implemented. Using the default value.

column_delimeter No String (2) Characters that will be used between Name And Value pairs in the transaction response. The system will use the character passed in this field or '=' as default if no value is passed. * This option is not implemented. Using the default value.

response_type No String (2) Constant value ('01'=text/html, '02'=text/plain, '03'=text/xml, '04'=redirect, '05'=binary) The system will use the reponse type passed in this field or text/html as default if no value is passed. Binary is the default type from the recordings. * This option is not implemented. Using the default value.

redirect_link No String (255)

Web page, which resides on the clients' server. The system will redirect the user to this link with response values in query string. response_type parameter should be set to '04' for this option. * This option is not implemented. Using the default value.

4

Transaction Types

Code Transaction Type Transaction Description

100 Account Creation Creates a single account. (If status_flag is not sent as "1" then the new account is created as a not-active account.)

View

101 Account Information Retrieves information about the specified account.

View

102 Account Removal Erases an Account from the IPCOM System. * Not Enabled Yet

View

103 Account Modification Modify account parameters/information. View 104 Account Activation Activates the specified account. View 105 Account Deactivation Deactivates the specified account. All the other

information on the account remains intact. The account may be re-activated again with activation.

View

106 Cdrs_export Allow export the Cdr report View 201 Recording Download Download a recording. View 301 Address Add Add an address to openser DB. View 302 Address Del Remove an address from openser DB. View 400 Send Single SMS Send a single SMS request. View 401 Create SMS Campaign Schelude a Campaign. View 402 Campaign SMS Status Campaign Status. View 403 Cancel SMS Campaign Cancel a requested schelude. View 404 SMS Export Report Allow export the report of campaign. View 405 Info Balance SMS Info Balance. View 700 Get queues (centers) Returns the centers represented by queues of

each campaign. View

800 Predictive Dialer Qualified Dispositions

Qualified Dispositions contacts. View

801 Predictive Dialer Program Creation Create a campaign of predictive dialer. View

802 Predictive Dialer Program Information

Retrieves information about the specified campaign.

View

803 Predictive Dialer Program Modification

Modify campaign parameters/information. View

804 Predictive Dialer Enable/Disable Activated or Deactivated campaign. View 805 Predictive Dialer Upload Numbers Upload bases predictive dialer. View 806 Predictive Dialer Upload Multiples

Contacts Upload multiples contacts predictive dialer. View

807 Predictive Dialer Queue Configuration

Configure queues of campaign. View

808 Export numbers Allow export the report of campaign. View 900 Broadcast Dialer List of

Campaigns To select a campaign Broadcast. View

901 Broadcast Dialer Add Base Add a base of Broadcast dialer. View 902 Broadcast Dialer Information Retrieves information about the specified base. View 903 Broadcast Dialer Modification Modify base parameters/information. View 904 Broadcast Dialer Enable/Disable Activated or Deactivated Bases. View 905 Broadcast Dialer Upload Numbers Upload numbers dialer broadcast. View 906 Broadcast Dialer Campaign Conf Configure of campaign. View 907 Broadcast Dialer Campaign

Information Information of Campaign. View



908 Broadcast Dialer Real Time Report Real Time Report. View 909 Broadcast Dialer Export Report Report base View 910 Broadcast Dialer Export CDR Report CDR View 911 Broadcast Audio Survey Add and Update Audio Campaign type Survey View 912 Broadcast Audio Survey Info Information Campaign type Survey View 913 Broadcast Audio Survey List Add and Update Audio Campaign type Survey

List View

914 Broadcast Audio Survey List Info Information Campaign type Survey List View

Product Identifier Types

Code

Product ID Description

6

Account Creation Request (100)

Field Name Required

Type Description

transaction_type

Yes Integer Constant value = 100

product_id Yes Integer Product identifier. Please ask IPCOM for a list of product_id values.

status_flag No* Integer Status of the new account to be created. Constant value (0=deactive, 1=active). Default is 0.

account_name Yes String (10)

10-Characters Account. Can be Letters or Numbers.

account_password

No* String (10)

If the password is not provided the system will generate a random password. In the case when the account is an agent the password will use an equivalent

first_names Yes String(20)

Can be first and middle name

last_name Yes String(20)

Last name

is_agent No Integer Can login as an Agent in a Queue. (0=no, 1=yes). Default is 0.

is_supervisor Yes Integer Is the account a supervisor? (0=no, 1=yes). Default 0.

is_monitor Yes Integer Has Monitoring privileges (0=no, 1=yes). Default 0.

supervisor No String(10)

Account_name who supervise this account.

monitor_groups No String(100)

Account_names who can monitor this account. Values must be separated by coma. Example: jdoe, ckent, agonzalez.

d_centro Yes String(10)

Centro or Location where this account resides. This information has to be pre-provisioned by IPCOM by written request.

d_camp Yes String(10)

Campaign. This information has to be pre-provisioned by IPCOM by written request.

reference_id No String (20)

Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Account Creation Response (100)

Field Name Field Type Description

response_code Integer Indicates the result of the transaction as an integer (Response Codes).

response_msg String (80) Indicates the result of the transaction as a text, which corresponds with the Response Code.

response_desc String (255) Brief description of the result, which corresponds with the Response Code.

transaction_type Integer Constant value = 100

transaction_id Integer Unique number assigned by IPCOM to identify the transaction in the system and can be used to submit a modification of this transaction at a later time, such as voiding, crediting or capturing the transaction.



product_id Integer Echoed.

status_flag Integer Echoed (or provided).

account_number String (10) Echoed.

account_password

String (10) Echoed (or provided).

account_domain String (50) Provided.

reference_id String (20) Echoed.

Account Creation Request (100) - Example

?transaction_type=100&product_id=99&user_id=user&user_pw=pass&account_name=2200&account_password=jfkl34kdf&first_names=Felipe+Andres&last_name=Fonseca+Marin&is_supervisor=0&is_monitor=0&d_centro=c001&d_camp=admin&status_flag=1&is_agent=0&reference_id=2201

Account Creation Response (100) - Example

response_code=1&response_msg=Success&response_desc=Account 2200 createdcorrectly.&transaction_type=100&product_id=99&status_flag=1&account_name=2200&account_password=jfkl34kdf&account_domain=c001.admin.test.ip-com.com&reference_id=2201&transaction_id=54934

8

Account Information Request (101)


transaction_type

Yes Integer Constant value = 101

account_name Yes String (10) Account Number

account_domain

Yes String (50) Provided in the Account Creation Response

reference_id No String (20) Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Account Information Response (101)

Field Name Type Description

response_code

Integer Indicates the result of the transaction as an integer.(Response Codes).

response_msg String (80)

Indicates the result of the transaction as a text, which corresponds with the Response Code.

response_desc

String (255)

Brief description of the result, which corresponds with the Response Code.

transaction_type

Integer Constant value = 101


status_flag Integer Status of the new account to be created. Constant value (0=deactive, 1=active). Default is 0.

account_name String (10)

10-Characters Account. Can be Letters or Numbers.

account_password

String (10)

If the password is not provided the system will generate a random password.

first_names String(20) Can be first and middle name

last_name String(20) Last name

is_agent Integer Can login as an Agent in a Queue. (0=no, 1=yes). Default is 0.

is_supervisor Integer Is the account a supervisor? (0=no, 1=yes). Default 0.

is_monitor Integer Has Monitoring privileges (0=no, 1=yes). Default 0.

supervisor String(10) Account_name who supervise this account.

monitor_groups

String(100)


d_centro String(10) Centro or Location where this account resides

d_camp String(10) Campaign

d_subcamp String(10) Additional information about the camping.

reference_id String

(20)

Reference identifier assigned by client. This value is recorded for

reporting purposes, and will also be passed back in the response.

http://auristechnology.com/webservices/




Account Information Request (101) - Example

?transaction_type=101&user_id=user&user_pw=pass&account_name=fafonseca&account_domain=c001.admin.test.ip-com.com

Account Information Response (101) – Example

response_code=1&response_msg=Success&response_desc=Dislplaying account fafonseca information.&transaction_type=101&account_name=fafonseca&reference_id=fafm01&status_flag=1&account_password=j4646&first_names=Felipe Andres&last_name=Fonseca Marin&is_agent=0&is_supervisor=0&is_monitor=0&supervisor=&monitor_groups=&d_centro=acap&d_camp=banc&d_subcamp=venta&transaction_id=1128

10

Account Removal Request (102)


transaction_type Yes Integer Constant value = 102

account_name Yes String (10) Account Name

account_domain Yes String (50) Provided in the Account Creation Response


Account Removal Response (102)


response_code Integer Indicates the result of the transaction as an integer(Response Codes).









Account Removal Request (102) – Example

?transaction_type=102&user_id=user&user_pw=pass&account_name= fafonseca &account_domain= c001.admin.test.ip-com.com

Account Removal Response (102)- Example response_code=1&response_msg=Success&response_desc=Account fafonseca removed correctly.&transaction_type=102&reference_id=&transaction_id=2960101

12

Account Modification Request (103)





reference_id No String (20) Reference identifier assigned by client.

Account Modification Response (103)






account_name String (10) Account Name

account_domain String (50) Account Domain

transaction_id Integer Unique number assigned by IPCOM to identify the transaction in the system.


Editable Fields

Field Name Type Description

status_flag Integer Constant value (0=deactive, 1=active).

account_password

String (10)

Password

first_names String(20) Can be first and middle name

last_name String(20) Last name

is_agent Integer Can login as an Agent in a Queue. (0=no, 1=yes). Default is 0.

is_supervisor Integer Is the account a supervisor? (0=no, 1=yes).

is_monitor Integer Has Monitoring privileges (0=no, 1=yes).

supervisor String(10) Account_name who supervise this account.

monitor_groups String(100)


d_centro String(10) This information has to be pre-provisioned by IPCOM by written request.

d_camp String(10) Campaign. This information has to be pre-provisioned by IPCOM by written request.

reference_id String (20) Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.




Account Modification Request (103) – Example

Change is_agent=0 to is_agent=1

?transaction_type=103&user_id=user&user_pw=pass&account_name= fafonseca &account_domain= c001.admin.test.ip-com.com&is_agent=1

Account Modification Response (103)- Example response_code=1&response_msg=Success&response_desc=Account fafonseca modificatedcorrectly.&transaction_type=103&account_name= fafonseca &reference_id=&account_domain= c001.admin.test.ip-com.com &transaction_id=296655

14

Account Activation Request (104)






Account Activation Response (104)











Account Activation Request (104) – Example

?transaction_type=104&user_id=user&user_pw=pass&account_name=fafonseca&account_domain=acap.banc_venta.cust.domain.com

Account Activation Response (104) – Example

response_code=1&response_msg=Success&response_desc=Account fafonseca activated correctly.&transaction_type=104&reference_id=&transaction_id=1118

16

Account Deactivation Request (105)

Field Name Required Type Description


account_name Yes String(10) Account Name

account_domain Yes String(50) Provided in the Account Creation Response

reference_id No String(20) Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Account Deactivation Response (105)











Account Deactivation Request (105) - Example

?transaction_type=105&user_id=user&user_pw=pass&account_name=fafonseca&account_domain=acap.banc_venta.cust.domain.com

Account Deactivation Response (105) - Example

response_code=1&response_msg=Success&response_desc=Account fafonseca deactivated correctly.&transaction_type=105&reference_id=&transaction_id=1117

18

CDRS Export Request (106)



product_id Yes String(10) Product identifier. Please ask IPCOM for a list of product_id values.

d_camp Yes String(10) Campaign. This information has to be pre-provisioned by IPCOM by written request.

d_centro No String(10) Centro or Location where this account resides. This information has to be pre-provisioned by IPCOM by written request.


CDRS Export Response (106)






filename String(50) File Name export

url String (100) Link for export file eg: https://ws.ip-com.com/exported/export-base-4107.csv





CDRS Exports Request (106) - Example

?transaction_type=106&user_id=user&user_pw=pass&product_id=99&d_camp=admin&d_centro=c001&date=2013-03-01

CDRS Exports Response (106) - Example

response_code=1&response_msg=Success&response_desc=File Export.&transaction_type=106&filename=export-cdrs-c001-admin-2013-03-01.csv&url=https://ws.ip-com.com/exported/export-cdrs-c001-admin-2013-03-01.csv&reference_id=&transaction_id=641093

20

Download a Recording Request (201)

Field Name Required

Type Description



cid Yes Integer Call identifier.

reference_id No String(20)

Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Download a Recording Response (201)





protocol http

host host

port port

filename Filename to be downloaded transaction_type Integer Constant value = 201





Download a Recording Request (201) - Example

transaction_type=201&user_id=prueba&user_pw=prueba&product_id=99&cid=113336318968

Download a Recording Response (201) - Example

response_code=1&response_msg=Success&response_desc=Displaying recording information.&transaction_type=201&protocol=http&host=65.208.88.65&port=59125&filename=2012/03/21/15/[email protected]@c004.rda.mc.xhosteos.com-NFQ.wav&transaction_id=296901

22

Address Add To Openser DB Request (301)



ip Yes String(50) IP address to add


Address Add To Openser DB Response (301)











Address Add To Openser DB Request (301) - Example

?transaction_type=301&user_id=user&user_pw=pass&ip=192.168.4.79

Address Add To Openser DB Response (301) –

Example

response_code=1&response_msg=Success&response_desc=IP 192.168.4.79 inserted correctly.&transaction_type=301&&transaction_id=296731

24

Remove an address from openser DB Request (302)



ip Yes String(50) IP address to add


Remove an address from openser DB Response (302)











Remove an address from openser DB Request (302) -

Example

?transaction_type=302&user_id=user&user_pw=pass&ip=192.168.4.79

Remove an address from openser DB Response (302)

– Example

response_code=1&response_msg=Success&response_desc=IP 192.168.4.79 Removed Correctly.&transaction_type=302&&transaction_id=296733

26

Send Single SMS Request (400)



product_id Yes Integer Product identifier. Please ask IPCOM for a list of product_id values for sms.

number Yes Integer Telephone number where the message will be sent

msg Yes String (160) The message to be sent reference_id No String (20) Reference identifier assigned by client. This

value is recorded for reporting purposes, and will also be passed back in the response.

Send Single SMS Response (400)





rate Double(8,4) Rate dispatch of sms

balance Double(8,4) Customer Credit







Send Single SMS Request (400) - Example

?transaction_type=400&user_id=user&user_pw=pass&product_id=99&number=573122740484&msg=this is a test of single SMS

Send Single SMS Response (400) - Example

response_code=1&response_msg=Success, Transaction accepted.&rate=0.019&balance=170.527&response_desc=Message queued for delivery.&transaction_type=400&&transaction_id=296083

28

Create SMS Campaign Request (401)


file Yes *.csv Path file, this parameter should be used as shown in the example of the transaction request 401. File size should not exceed 10 MB.



campaign_name Yes String (50) Campaign name example: news SMS country Yes Integer 55 -> Brasil

573 - >Colombia 52 -> México 519 -> Perú

date_schedule_sms Yes String (20) Date for the campaign to be scheduled Format requiered: yyyy-mm-dd HH:ii:ss valid format= 2012-03-29 18:21:10 valid format= 2012-03-29 05:30:59 invalid format= 2012/03/29 05:30:59 invalid format= 2012-03-29 5:30:59 invalid format= 12-03-2012 05:30:59

msg Yes String (160) The message to be sent reference_id No String (20) Reference identifier assigned by client. This


Create SMS Campaign Response (401)





campid Integer Identifier assigned by system. When created a new campaign is emitted an identifier, example: campid = 15 use it to check the status or to cancel a campaign

balance Double(8,4) New Customer Credit

Upload_numbers Integer Amount of numbers uploaded







FORMAT FILE (401) - Example 1. The phone number must be numeric. 2. The phone number can’t have spaces eg (573 223 2342 32) is not valid. 3. The phone number can’t have characters of any type (+573-223-234232) is not valid. 4. The number that goes up must include Country code example (573) 5. Example valid (573223234232) is correct. 6. If is a customized SMS, message should not contain (ñ Ñ ç Ç ... etc) nor coma separate (,) or accents (á é í) etc. 7. Remember that the file must be *. csv and weight no more than 10MB.

EXAMPLE FORMAT FILE SMS CUSTOMIZE 573204419350,Respetado cliente esta es una prueba de creacion de campana SMS 573202640494,Respetado cliente esta es una prueba de creacion de campana SMS 573202740424,Puede escribirnos al correo 573202740434,Recuerde que su creadito vence el dia. 573202742342,Respetado cliente esta es una prueba de creacion de campanaSMS

EXAMPLE FORMAT FILE ONLY NUMBERS 573204419280 573202740494 573202740424 573202740434 573202742342

30

Create SMS Campaign Request (401) - Example

The client must pass data through the use of the library curl as shown in the example: <?

$error = '';

//$file = "C:\\Temp\testsms.csv";// Example For Windows

$file = "/home/testsms.csv";// Example For Linux

$upload_url = "http://ws.ip-com.com";

$data = array('file' => "@$file",

'transaction_type'=>401,

'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campaign_name'=>'test sms for webservices',

'country'=>573,

'date_schedule_sms'=>'2012-07-11 14:00:00',

'msg'=>'Good Morning {var}'//{var} only for customized sms

);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $upload_url);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

$response = curl_exec($ch);

$error = curl_error($ch);

curl_close($ch);

if ($error != '') echo 'Error -> '.$error.'<BR>';

?>



Create SMS Campaign Response (401) - Example

Data will be received by the POST method and processed by the webservice giving an answer as above shows the example:

response_code=1&response_msg=Success, Created Successful.&response_desc=The campaign has been created correctly.&campid=21&transaction_type=401&&transaction_id=300313

32

Campaign Status SMS Request (402)



campid Yes Integer Identifier assigned by system. When created a new campaign is emitted an identifier, example: campid = 15 use it to check the status or to cancel a campaign


Campaign Status SMS Response (402)











Campaign Status SMS Request (402) - Example

?transaction_type=402&user_id=user&user_pw=pass&campid=15

Campaign Status SMS Response (402) - Example

response_code=1&response_msg=Sending Complete&response_desc=&transaction_type=402&&transaction_id=296089

34

Cancel SMS Scheduled Campaign Request (403)



campid Yes Integer Identifier assigned by system. When created a new campaign is emitted an identifier, example: campid = 15 use it to check the status or to cancel a campaign


Cancel SMS Scheduled Campaign Response (403)











Cancel SMS Scheduled Campaign Request (403) -

Example


Cancel SMS Scheduled Campaign Response (403) -

Example

response_code=1&response_msg= Success, The campaign canceled SMS. &response_desc= The campaign has been cancelled &transaction_type=402&&transaction_id=296089

36

SMS Export Report Request (404)




campid Yes integer Identifier assigned by system. When created a new campaign is emitted an identifier, example: campid = 15


SMS Export Report Response (404)


response_code integer Indicates the result of the transaction as an integer(Response Codes).




filename String(50) File Name export.

url String (100) Link for export file eg: https://ws.ip-com.com/exported/export-report-sms-15.csv

total_numbers Integer Amount of processed numbers. fixed_numbers Integer Amount of fixed numbers. delivered_numbers Integer Numbers delivered.

reference_id String (20)




SMS Export Report Request (404) – Example

?transaction_type=404&user_id=user&user_pw=pass&product_id=99&campid=15

SMS Export Report Response (404) – Example response_code=1&response_msg=Success&response_desc=File Export.&transaction_type=404&filename=export-report-sms-15.csv&url=https://ws.ip-com.com/exported/export-report-sms-15.csv&total_numbers=15&fixed_numbers=0&delivered_numbers=15&reference_id=&transaction_id=398233

38

Info Balance SMS Request (405)





Info Balance SMS Response (405)






name_user String(20) Customer Name balance Double(8,4) Customer Credit





Info Balance SMS Request (405) – Example

?transaction_type=405&user_id=user&user_pw=pass&product_id=99

Info Balance SMS Response (405) – Example response_code=1&response_msg=Success&response_desc=Your Balance is 20.5 &transaction_type=405&name_user=IPCOM Prueba&balance=20.5 &reference_id=&transaction_id=398307

40

Get Queues (Centers) Request (700)




d_center No String (10) Center filter. This information has to be pre-provisioned by IPCOM by written request. If d_center = % returned all

d_camp No String (10) Campaign filter. This information has to be pre-provisioned by IPCOM by written request. If d_camp= % returned all


Get Queues (Centers) Response (700)






queue String(255) Format VALUE;DESCRIPTION example: c001.wp.test;Admin C001-webphone If is returned more of one center is separated for coma. example: c001.wp.test;Admin C001-webphone, c001.admin.test;Admin C001-Admin, c001.ad.test;Admin C001-Ad






Get Queues (Centers) Request (700) - Example

Campaign and center filter: ?transaction_type=700&user_id=user&user_pw=pass&product_id=99&d_centro=001&d_camp=wp

Only center filter: ?transaction_type=700&user_id=user&user_pw=pass&product_id=99&d_centro=001&d_camp=%

Center filter:

?transaction_type=700&user_id=user&user_pw=pass&product_id=99&d_centro=001

Any filter:

?transaction_type=700&user_id=user&user_pw=pass&product_id=99&d_centro=%&d_camp=%

OR TOO

?transaction_type=700&user_id=test&user_pw=pass&product_id=99

Get Queues (Centers) Response (700) - Example

Campaign and center filter: response_code=1&response_msg=Success&response_desc=returned centers.&transaction_type=700&queue=c001.wp.test;Admin C001-

webphone&transaction_id=359583

Only center filter: response_code=1&response_msg=Success&response_desc=returned centers.&transaction_type=700&queue=c001.admin.test;Admin C001-Admin,c001.czlla.test;Admin C001-Callzilla,c001.ca.test;Admin C001-Cartera,c001.oa.test;Admin C001-oreka,c001.si.test;Admin C001-Solati,c001.wp.test;Admin C001-webphone&transaction_id=359585

Any filter: response_code=1&response_msg=Success&response_desc=returned centers.&transaction_type=700&queue=c001.admin.test;Admin C001-Admin,c001.czlla.test;Admin C001-Callzilla,c001.ca.test;Admin C001-Cartera,c001.oa.test;Admin C001-oreka,c001.si.test;Admin C001-Solati,c001.wp.test;Admin C001-webphone,cba.admin.test;BARRANQUILLA-Admin,cba.czlla.test;BARRANQUILLA-Callzilla,cba.ca.test;BARRANQUILLA-Cartera,cba.oa.test;BARRANQUILLA-oreka,cba.si.test;BARRANQUILLA-Solati,cba.wp.test;BARRANQUILLA-webphone,c02.admin.test;Colombia Center-Admin,c02.czlla.test;Colombia Center-Callzilla,c02.ca.test;Colombia Center-Cartera,c02.oa.test;Colombia Center-oreka,c02.si.test;Colombia Center-Solati, c003.czlla.test;Medellin-Callzilla,c003.ca.test;Medellin-Cartera,c003.oa.test;Medellin-oreka,c003.si.test;Medellin-Solati,c003.wp.test;Medellin-webphone&transaction_id=359589

42

Predictive Qualified Dispositions Request (800)



cid Yes Integer Call identifier. popup url, return (cid) field Ej: cid=21105533

number Yes Integer Phone number to qualify redial_contact Yes Integer 0 - No redial.

1 - Redial LEAD.

status_contact Yes Integer 0 - Disables the Contact. 1 - Remains active Contact.


Predictive Qualified Dispositions Response (800)











Predictive Qualified Dispositions Request (800) -

Example

No redial:

?transaction_type=800&user_id=user&user_pw=pass&cid=21105533&number=5717423407&redial_contact=0&status_contact=0 Redial + Disabled contact:

?transaction_type=800&user_id=user&user_pw=pass&cid=21105533&number=5717423407&redial_contact=1&status_contact=0 Redial + Remains active Contact:

?transaction_type=800&user_id=user&user_pw=pass&cid=21105533&number=5717423407&redial_contact=1&status_contact=1

Predictive Qualified Dispositions Response (800) -

Example

0 - No redial:

response_code=1&response_msg=Success&response_desc=call completed.&transaction_type=800&&transaction_id=336227

1 - Redial:

response_code=1&response_msg=Success, Redial&response_desc=New Phone To Dial (573202740000)&transaction_type=800&&transaction_id=336337

LEAD Disabled:

response_code=32&response_msg= LEAD Disabled&response_desc= All the numbers have been used.&transaction_type=800&&transaction_id=336227

44

Predictive Program Creation Request (801)




campaign_name Yes String (50) Campaign Name

campaign_type Yes Integer 1 -> Predictive Dialer 2 -> Manual Dialer

progresivo Yes integer 0 -> Inactive (Default) 1 -> Activate

datetime_init Yes String (20) Start date eg: 2012-07-17

datetime_end Yes String (20) End date eg: 2012-07-25

daytime_init Yes String (8) Start Hour eg: 00:00:00

daytime_end Yes String (8) End Hour eg: 20:00:00

based_on_ASR Yes integer 0 -> Inactive 1 -> Activate (Default)

retries Yes integer Number of retries 0 - 20

call_timeout Yes integer Call Timeout (seconds) 70 -> Default 15 -> Min. 240 -> Max.

queue Yes String (30) The Format of queue is:

VALUE;DESCRIPTION queue = c001.wp.test;Admin C001-webphone in this field should only enter the value: VALUE is => c001.wp.test

custom_url No String (255) NOTE: for the page to be re routed properly, it is required to include the (http://) + domain (www.google.com) .

script No* Memo A small training text for the agent. reference_id No String (20)

Predictive Program Creation Response (801)






campid integer Campaign id

campaign_name String (50) Campaign Name created

transaction_id Integer Unique number assigned by IPCOM to identify the transaction.





Predictive Program Creation Request (801) - Example

?transaction_type=801&product_id=99&user_id=user&user_pw=pass&queue=c001.wp.test&call_timeout=15&retries=5&based_on_ASR=1&daytime_end=20:00:00&daytime_init=00:00:00&datetime_end=2012-07-17&datetime_init=2012-07-22&progresivo=0&campaign_type=1&campaign_name=TEST CREATION CAMPAIGN

Predictive Program Creation Response (801) – Example response_code=1&response_msg=Success, Created Successful.&response_desc=The campaign has been created correctly.&transaction_type=801&campid=5095&campaign_name=TEST CREATION CAMPAIGN&transaction_id=359663

46

Predictive Program Information Request (802)



campid Yes integer Campaign id



Predictive Program Information Response (802)






product_id Integer Product identifier.

campaign_name String (50) Campaign Name

campaign_type Integer Campaign Type progresivo integer Progresive

datetime_init String (20) Start date

datetime_end String (20) End date

daytime_init String (8) Start Hour

daytime_end String (8) End Hour

based_on_ASR integer Based on ASR

retries integer Number of Retries

call_timeout integer Call Timeout (seconds)

queue String (30) Queue Eg: c001.wp.test

custom_url String (255) URL Eg: http://www.google.com

script Memo A small training text for the agent. transaction_id integer Unique number assigned by IPCOM to identify

the transaction. reference_id String (20) Echoed.




Predictive Program Information Request (802) -

Example

?transaction_type=802&user_id=user&user_pw=pass&campid=5109&product_id=99

Predictive Program Information Response (802) – Example

response_code=1&response_msg=Success&response_desc=Displaying Campaign information.&transaction_type=802&campaign_name=TEST CREATION CAMPAIGN&campaign_type=1&campaign_status=T&datetime_init=2012-07-22&datetime_end=2012-07-17&daytime_init=00:00:00&daytime_end=20:00:00&retries=1&queue=c001.wp.test&script=&custom_url=&product_id=99&progresivo=0&call_timeout=15&based_on_ASR=1&transaction_id=359705

48

Predictive Program Modification Request (803)



campid Yes Integer Campaign id



Predictive Program Modification Response (803)








campaign_modified String (20) Date modification






Editable Fields


campaign_name No String (50) Campaign Name

campaign_type No Integer 1 -> Predictive Dialer 2 -> Manual Dialer

campaign_status No String (1) A -> activated T -> deactivated

progresivo No integer 0 -> Inactive (Default) 1 -> Activate

datetime_init No String (20) Start date eg: 2012-07-17

datetime_end No String (20) End date eg: 2012-07-25

daytime_init No String (8) Start Hour eg: 00:00:00

daytime_end No String (8) End Hour eg: 20:00:00

based_on_ASR No integer 0 -> Inactive 1 -> Activate (Default)

retries No integer Number of retries 0 - 20

call_timeout No integer Call Timeout (seconds) 70 -> Default 15 -> Min. 240 -> Max.

queue No String (30) The Format of queue is eg:

VALUE;DESCRIPTION queue = c001.wp.test;Admin C001-webphone in this field should only enter the value: VALUE is => c001.wp.test

custom_url No String (255) NOTE: for the page to be re routed properly, it is required to include the (http://) + domain (www.google.com) .

script No Memo A small training text for the agent. reference_id No String (20)

50

Predictive Program Modification Request (803) -

Example

?transaction_type=803&user_id=user&user_pw=pass&campid=5109&product_id=99&campaign_type=2&campaign_status=T&datetime_init=2012-07-21&datetime_end=2012-07-22&daytime_init=00:00:00&daytime_end=20:00:00&retries=1&queue=c001.wp.test&script=hola esto debe decirle al cliente&custom_url=http://www.google.com&progresivo=1&call_timeout=23&based_on_ASR=1

Predictive Program Modification Response (803) – Example response_code=1&response_msg=Success&response_desc=Campaign (5109) modificated correctly.&transaction_type=803&campid=5109&campaign_name=TEST CREATION CAMPAIGN&campaign_modified=2012-07-25 12:54:16&transaction_id=359707



Predictive Dialer Enabled / Disabled Request (804)



campid Yes Integer Campaign id


campaign_status No String (1) A -> activated T -> deactivated


Predictive Dialer Enabled / Disabled Response (804)








campaign_modified String (20) Date modification




52

Predictive Dialer Enabled / Disabled Request (804) -

Example

ACTIVATED ?transaction_type=804&user_id=user&user_pw=pass&campid=5109&product_id=99&campaign_status=A DEACTIVATED ?transaction_type=804&user_id=user&user_pw=pass&campid=5109&product_id=99&campaign_status=T

Predictive Dialer Enabled / Disabled Response (804) – Example ACTIVATED

response_code=1&response_msg=Success&response_desc=Campaign TEST CREATION CAMPAIGN activated correctly.&transaction_type=804&&transaction_id=359727 DEACTIVATED response_code=1&response_msg=Success&response_desc=Campaign TEST CREATION CAMPAIGN deactivated correctly.&transaction_type=804&&transaction_id=359729



Predictive Upload Numbers Request (805)


file Yes *.csv Path file, this parameter should be used as shown in the example of the transaction request 805 File size should not exceed 10 MB



campid Yes Integer Campaign id. reference_id No String (20) Reference identifier assigned by client. This


Predictive Upload Numbers Response (805)






upload_numbers Integer Amount of numbers uploaded




54

FORMAT FILE (805) - Example 1. The phone number must be numeric. 2. Example valid (573223234232) is correct. 4. Remember that the file must be *. csv and weight no more than 10MB.

EXAMPLE FORMAT FILE WITH ADDITIONAL PARAME-TERS ,nombre,direccion,ciudad 573202740434,John Alexander Mendez,calle 17 # 113 - 80,bogota colombia 573115355044,Freddy Paez,calle 12 # 11-13,bogota colombia 573204419350,Camilo Beltran,cra 22 # 55 – 08, funza 573202640494,Carlos Otalora,cra 34 # 102 – 08, cali 573202740424,German Vargas,cra 12 # 33 – 43, envigado




Predictive Upload Numbers Request (805) - Example


error_reporting(E_ALL);

ini_set('display_errors','On');

//error_reporting (E_ALL ^ E_NOTICE);

$error = '';

//$file = "C:\\Temp\ upload_numbers_pdialer.csv ";// Example For Windows

$file = "/home/upload_numbers_pdialer.csv";// Example For Linux




'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campid'=>5007

);

$ch = curl_init();






curl_close($ch);


?>

56

Predictive Upload Numbers Response (805) - Example

Data will be received by the POST method and processed by the webservice giving an answer as above shows the example: response_code=1&response_msg=Success&response_desc=Upload Numbers Successful.&transaction_type=805&upload_numbers=3&transaction_id=360641



Predictive Upload Multiples Contacts Request (806)







Predictive Upload Multiples Contacts Response (806)






inserted Integer Amount of numbers inserted

lines Integer Amount of lines uploaded




58

FORMAT FILE (806) - Example

1. The phones numbers must be numeric. 2. The phones numbers must separated by pipe.

3. Example valid (5717425407|573202540494|2925601) is correct. 4. if the file contains additional parameters must be separated by commas

5. Remember that the file must be *. csv and weight no more than 10MB.

EXAMPLE FORMAT FILE WITH ADDITIONAL PARAME-

TERS celular|numero1|numero2|numero3|numero4,token,nombre,apellido 5717425407|573202540494|2925601|573125570003|572505699073,123123,Carlos,Mendez 17861271224|573012699073|573115245124|573134126578|2912608,111111,Carolina,Paez 2983601|17868337224|5737423407||573202370494,x03411232,Sofia,Rincon



Predictive Upload Numbers Request (806) - Example





$error = '';

//$file = "C:\\Temp\ multiplescontacts.csv ";// Example For Windows

$file = "/home/multiplescontacts.csv";// Example For Linux $upload_url = "http://ws.ip-com.com";



'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campid'=>5109

);

$ch = curl_init();






curl_close($ch);


?>

60

Predictive Upload Numbers Response (806) - Example

Data will be received by the POST method and processed by the webservice giving an answer as above shows the example: response_code=1&response_msg=Success&response_desc=Upload Contacts Successful.&transaction_type=806&inserted=14&lines=4&transaction_id=360725



Predictive Configuration Queues Request (807)

Field Name Required

Field Type Description


queue Yes String(128) Queue of campaign eg: c001.wp.test

timeout No Integer How long do we let the phone ring before we consider this a Timeout? Timeout in seconds when calling an agent timeout=15

retry No Integer How long do we wait before trying all the members again? retry = 5

wrapuptime No Integer This setting can be in agents or in the queue. After a successful call, how long to wait before sending a potentially free member another call (default is 0, or no delay)

strategy No String(20) Calls are distributed among the members handling a queue with one of several strategies ringall: ring all available channels until one answers (default) roundrobin: take turns ringing each available interface (depreciated in 1.4, use rrmemory) leastrecent: ring interface which was least recently called by this queue fewestcalls: ring the one with fewest completed calls from this queue random: ring random interface rrmemory: round robin with memory, remember where we left off last ring pass linear: Rings interfaces in the order they are listed in the configuration file. Dynamic members will be rung in the order in which they were added. (new in 1.6) wrandom: Rings a random interface, but uses the agent's penalty as a weight (new in 1.6) rings random interface, but uses the member's penalty as a weight when calculating their metric. So a member with penalty 0 will have a metric somewhere between 0 and 1000, and a member with penalty 1 will have a metric between 0 and 2000, and a member with penalty 2 will have a metric between 0 and 3000. Please note, if using this strategy, the member penalty is not the same as when using other queue strategies. It is ONLY used as a weight for calculating metric. strategy=rrmemory

62

memberdelay No Integer This sets a delay period between the time that the member answers the call and when it is connected. If you wish to have a delay before the member is connected to the caller (or before the member hears any announcement messages), set this to the number of seconds to delay. memberdelay = 5

timeoutrestart No Integer If timeoutrestart is set to yes, then the time out for an agent to answer is reset if a BUSY or CONGESTION is received. This can be useful if agents are able to cancel a call with reject or similar.(I found that when agents return NOANSWER (ring, no-answer) this also causes the queue to move to the next agent in a round robin) timeoutrestart = yes


Predictive Configuration Queues Response (807)






queue String(128) Queue of campaign eg: c001.wp.test






Predictive Configuration Queues Request (807) -

Example

?transaction_type=807&user_id=user&user_pw=pass&queue=c001.wp.test&timeout=19

Predictive Configuration Queues Response (807) – Example response_code=1&response_msg=Success&response_desc=queue (c001.wp.test) modificated correctly.&transaction_type=807&queue=c001.wp.test&transaction_id=361079

64

Predictive Export Numbers Request (808)



product_id Yes String(10) Product identifier. Please ask IPCOM for a list of product_id values.

campid Yes Integer Campaign id. reference_id No String(20) Reference identifier assigned by client. This value

is recorded for reporting purposes, and will also be passed back in the response.

Predictive Export Numbers Response (808)












Predictive Exports Numbers Request (808) - Example

?transaction_type=808&user_id=user&user_pw=pass&product_id=99&campid=1381

Predictive Exports Numbers Response (808) -

Example

response_code=1&response_msg=Success&response_desc=File Export.&transaction_type=808&filename=export_camp_1381.csv&url=https://ws.ip-com.com/exported/export_camp_1381.csv&reference_id=&transaction_id=641109

66

Broadcast Dialer - List of Campaigns Request (900)





Broadcast Dialer - List of Campaigns Response (900)






campid String (255) Format VALUE;DESCRIPTION example: 1235;PRUEBA If is returned more of one campaign id is separated for comas. example: 1235;PRUEBA, 1233;SURVEY LIST, 1279;SURVEY TEST






Broadcast Dialer - List of Campaigns Request (900) -

Example

?transaction_type=900&user_id=user&user_pw=pass&product_id=99

Broadcast Dialer - List of Campaigns Response (900) – Example response_code=1&response_msg=Success&response_desc=Returned Campaigns.&transaction_type=900&campid =1235;PRUEBA,1233;SURVEY LIST,1279;SURVEY TEST

68

Broadcast Dialer Add Base Request (901)



campid Yes Integer Campaign Id eg: campid=1235

product_id Yes Integer Product identifier. Please ask IPCOM for a list of product_id values.eg: product_id=99

datetime_init Yes String (20) Start date eg: 2012-07-17

datetime_end Yes String (20) End date eg: 2012-07-25

daytime_init Yes String (8) Start Hour eg: 00:00:00

daytime_end Yes String (8) End Hour eg: 20:00:00


Broadcast Dialer Add Base Response (901)






campid Integer Campaign Id

base_id Integer Base id

base String (20) Base Name

text_notes Memo Notes






Broadcast Dialer Add Base Request (901) - Example

?transaction_type=901&user_id=user&user_pw=pass&campid=1235&product_id=99&datetime_init=2012-07-17&datetime_end=2012-07-17&daytime_init=00:00:00&daytime_end=20:00:00

Broadcast Dialer Add Base Response (901) – Example response_code=1&response_msg=Success&response_desc=The base has been created correctly.&transaction_type=901&campid=1235&base_id=3561&base=20120730134804&text_notes=create -> 2012-07-30 13:48:04&transaction_id=363773

70

Broadcast Dialer Information Request (902)



base_id Yes integer Base Id


Broadcast Dialer Information Response (902)







status Integer Status of base 1 -> activated 0 -> deactivated status = 2 -> Runing Is only of information, this status is returned for system when campaign is running.

datetime_init String (20) Start date

datetime_end String (20) End date

daytime_init String (8) Start Hour

daytime_end String (8) End Hour

factor Float Eg: 1.2

text_notes Memo A small text that summarizes the changes that have taken place at the base.

transaction_id integer Unique number assigned by IPCOM to identify the transaction.





Broadcast Dialer Information Request (902) –

Example

?transaction_type=902&user_id=user&user_pw=pass&base_id=3561

Broadcast Dialer Information Response (902) – Example response_code=1&response_msg=Success&response_desc=Displaying base information.&transaction_type=902&base=20120730134804&status=0&datetime_init=2012-07-17&datetime_end=2012-07-17&daytime_init=00:00:00&daytime_end=20:00:00&factor=1.2&text_notes=create -> 2012-07-30 13:48:04&transaction_id=363809

72

Broadcast Dialer Modification Request (903)



base_id Yes Integer Base id


Broadcast Dialer Modification Response (903)






base_id integer Base Id




EDIT FILEDS Field Name Required Field Type Description

status No Integer 1 -> activated 0 -> deactivated

datetime_init No String (20) Start date eg: 2012-07-17

datetime_end No String (20) End date eg: 2012-07-25

daytime_init No String (8) Start Hour eg: 00:00:00

daytime_end No String (8) End Hour eg: 20:00:00





Broadcast Dialer Modification Request (903) -

Example

?transaction_type=903&user_id=user&user_pw=pass&base_id=3561&status=1&datetime_init=2012-07-21&datetime_end=2012-07-22&daytime_init=00:00:00&daytime_end=20:00:00

Broadcast Dialer Modification Response (903) – Example response_code=1&response_msg=Success&response_desc=Base (20120730134804) modificatedcorrectly.&transaction_type=903&base_id=3561&base=20120730134804&transaction_id=364339

74

Broadcast Dialer Enabled / Disabled Request (904)



base_id Yes Integer Base id

status No Integer 1 -> activated 0 -> deactivated


Broadcast Dialer Enabled / Disabled Response (904)






base_id integer Base Id







Broadcast Dialer Enabled / Disabled Request (904) -

Example

ACTIVATED ?transaction_type=904&user_id=user&user_pw=pass&base_id=3561&status=1 DEACTIVATED ?transaction_type=904&user_id=user&user_pw=pass&base_id=3561&status=0

Broadcast Dialer Enabled / Disabled Response (904) – Example ACTIVATED response_code=1&response_msg=Success&response_desc=Base 20120730134804 activated correctly.&transaction_type=904&&transaction_id=364333 DEACTIVATED response_code=1&response_msg=Success&response_desc=Base 20120730134804 deactivated correctly.&transaction_type=904&&transaction_id=364335

76

Broadcast Dialer Upload Numbers Request (905)





campid Yes Integer Campaign id. base_id Yes Integer Base Id


Broadcast Dialer Upload Numbers Response (905)






text_notes Memo Date and quantity loaded or duplicate numbers, if any.






FORMAT FILE (905) - Example 1. The phone number must be numeric. 2. Example valid (573223234232) is correct. 4. Remember that the file must be *. csv and weight no more than 30MB.

EXAMPLE FORMAT FILE WITH ADDITIONAL PARAME-TERS ,nombre,direccion,ciudad 573202740434,John Alexander Mendez,calle 17 # 113 - 80,bogota colombia 573115355044,Freddy Paez,calle 12 # 11-13,bogota colombia 573204419350,Camilo Beltran,cra 22 # 55 – 08, funza 573202640494,Carlos Otalora,cra 34 # 102 – 08, cali 573202740424,German Vargas,cra 12 # 33 – 43, envigado


78

Broadcast Dialer Upload Numbers Request (905) -

Example





$error = '';

//$file = "C:\\Temp\ upload_numbers_dbroadcast.csv ";// Example For Windows

$file = "/home/upload_numbers_dbroadcast.csv";// Example For Linux




'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campid'=>1235,

'base_id'=>3561

);

$ch = curl_init();






curl_close($ch);


?>



Broadcast Dialer Upload Numbers Response (905) -

Example

Data will be received by the POST method and processed by the webservice giving an answer as above shows the example: response_code=1&response_msg=Success&response_desc=Upload Numbers Successful.&transaction_type=905&notes= 2012-07-20 17:45:42: 2 uploaded, 0 duplicated.&transaction_id=360641

80

Broadcast Dialer Campaign Conf Request (906)


audio_file Yes *.wav,*.mp3 Path file, this parameter should be used as shown in the example of the transaction request 906 File size should not exceed 5 MB





Broadcast Dialer Campaign Conf Response (906)






audio_file String (255) File name uploaded.






EDIT FILEDS Field Name Required Field Type Description

campaign_name No String(50) Campaign Name

status No Integer 1 -> activated (Default) 0 -> deactivated

campaign_type No Integer 0 -> Audio Broadcast (Default) 1 -> Survey 3 -> Transfer 4 -> Survey List

max_sim_calls No Integer Simultaneos Calls. 0 -> Min (Default) 100 -> Max

max_contact_ratio

No Double(2,2) Radio contact % eg: 99.99 70.00 -> (Default) 1.00 -> Min 99.99 -> Max

retries No Integer 1 to 5 1 -> Min (Default) 5 -> Max

time_between_attemps

No Integer 1 to 300 minutes 1 -> Min (Default) 300 -> Max

transfer No* String(20) Only if campaign type is of transfer


Important!

If max_sim_calls parameter (Simultaneous Calls) contain the value by default = 0 the campaign will not be marked until that value is between 1 and 100, remember that the value of this field depends of the amount of numbers to be dialed and the time within which must be dialed, for more information contact our technical support.

82

Broadcast Dialer Campaign Conf Request (906) -

Example





$error = '';

//$file = "C:\\Temp\ principal-encuesta.wav ";// Example For Windows

$audio_file = "/home/principal-encuesta.wav";// Example For Linux


$data = array('file' => "@$audio_file",


'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campid'=>1595,

'campaign_type'=>0,

'campaign_name'=>'PRUEBA 800_20120719',

'status'=>1

);

$ch = curl_init();






curl_close($ch);


?>



Broadcast Dialer Campaign Conf Response (906) -

Example


response_code=1&response_msg=Success&response_desc=Update Campaign (BROADCAST WS) Successful.&transaction_type=906&audio_file=principal-encuesta.wav&transaction_id=372519

84

Broadcast Dialer Campaign Information Request (907)



campid Yes integer Campaign id. reference_id No String (20)

Broadcast Dialer Campaign Information Response (907)






campaign_name String(50) Campaign Name

status Integer Status of campaign

campaign_type Integer Campaign Type

max_sim_calls Integer Simultaneos Calls.

max_contact_ratio Double(2,2) Radio contact % eg: 99.99

retries Integer Attemps.

time_between_attemps

Integer Time Between Attemps.

transfer String(20) Only if campaign type is of transfer





Broadcast Dialer Campaign Information Request (907)

– Example

? transaction_type=907&user_id=user&user_pw=pass&campid=1595

Broadcast Dialer Campaign Information Response (907) – Example response_code=1&response_msg=Success&response_desc=Displaying Campaign information.&transaction_type=907&campaign_name=PRUEBA 800_20120719&status=1&campaign_type=0&max_sim_calls=1&max_contact_ratio=99.99&retries=1&time_between_attemps=2&transaction_id=367319

86

Broadcast Dialer Real Time Report Request (908)






Broadcast Dialer Real Time Report Response (908)






campaign_name String(50) Campaign Name

since String (20) Date / Time of Start

until String (20) Date / Time of Completion

status Integer Status

max_sim_calls Integer Simultaneos Calls configured

numbers Integer Amount numbers

queued Integer Amount numbers in queued

dialed String(20) Amount of dialed numbers

answered Integer Amount of answered calls

contact Decimal(3,2) Radio contact % eg: 99.99

asr Decimal(3,2) Measures the percentage of calls connected compared to total calls made.

retries Configured number of attempts time_between_attemps

Integer Time between attempts configured in minutes

wait_for_answer Integer wait for answer in seconds





Broadcast Dialer Real Time Report Request (908) –

Example

?transaction_type=908&user_id=user&user_pw=pass&product_id=99&base_id=4107

Broadcast Dialer Real Time Report Response (908) – Example response_code=1&response_msg=Success&response_desc=Displaying base real time information.&transaction_type=908&campaign_name=BROADCAST WS&since=08/15/12 17:00&until=08/15/12 18:00&status=0&max_sim_calls=5&numbers=2&queued=3&dialed=3&answered=2&contact=100&asr=66.67&retries=8&time_between_attemps=1&wait_for_answer=30&transaction_id=373087

NOTE You should call each x time the transaction to obtain the information in real time and the base must be activated to work properly this transaction.

88

Broadcast Dialer Export Report Request (909)




f_type_exp Yes Integer 1 -> CSV 2 -> CSV WITH ATTRIBUTES


Broadcast Dialer Export Report Response (909)












Broadcast Dialer Export Report Request (909) –

Example

?transaction_type=909&user_id=user&user_pw=pass&base_id=4107&f_type_exp=1

Broadcast Dialer Export Report Response (909) – Example response_code=1&response_msg=Success&response_desc=File Export.&transaction_type=909&filename=export-base-4107.csv&url=https://ws.ip-com.com/exported/export-base-4107.csv&transaction_id=373479

NOTE Use option ( 2 -> CSV WITH ATTRIBUTES ) only if your file contains additional information, the download may take longer.

90

Broadcast Dialer Export CDR Report Request (910)





Broadcast Dialer Export CDR Report Response (910)







url String (100) Link for export file eg: https://ws.ip-com.com/exported/export-base-4101-CDR.csv





Broadcast Dialer Export CDR Report Request (910) –

Example

?transaction_type=910&user_id=user&user_pw=pass&base_id=4101

Broadcast Dialer Export CDR Report Response (910) – Example response_code=1&response_msg=Success&response_desc=File Export.&transaction_type=910&filename=export-base-4101-CDR.csv&url=https://ws.ip-com.com/exported/export-base-4101-CDR.csv&transaction_id=373483

92

Broadcast Audio Survey Request (911)


audio_file Yes *.wav Path file, this parameter should be used as shown in the example of the transaction request 911 File size should not exceed 5 MB



campid Yes Integer Campaign id. survey_answer Yes Integer 0 to 9. reference_id No String (20) Reference identifier assigned by client. This


Broadcast Audio Survey Response (911)





transaction_type Integer Constant value = 911.

campaign_name String(50) Campaign Name. survey_answer Integer 0 to 9.




EDIT FILEDS



survey_answer Yes Integer 0 to 9. reference_id No String (20)




Broadcast Audio Survey (911) - Example





$error = '';

//$file = "C:\\Temp\ answer1.wav ";// Example For Windows

$audio_file = "/home/answer1.wav";// Example For Linux




'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campid'=>1279,

'survey_answer'=>1

);

$ch = curl_init();






curl_close($ch);


?>

94

Broadcast Audio Survey Response (911) - Example


response_code=1&response_msg=Success&response_desc=Upload audio survey Successful.&transaction_type=911&campaign_name=SURVEY_TEST&survey_answer=1&audio_file=answer1.wav&transaction_id=375831



Broadcast Audio Survey Information Request (912)




Broadcast Audio Survey Information Response (912)






survey_answer String(50) Format VALUE example: survey_answer= 1 If is returned more of one answer_id is separated for comas. example: survey_answer= 1,2,3,4

audio_file Memo Format VALUE example: audio_file=201205181032260.opcion1.wav If is returned more of one Audio file is separated for comas. example: audio_file=201205181032260.opcion1.wav,201205181032460.opcion2.wav,201205181033020.opcion3.wav,INTRO_EEB.wav



96

Broadcast Audio Survey Information Request (912) –

Example


Broadcast Audio Survey Information Response (912) – Example response_code=1&response_msg=Success&response_desc=Returned Answers and Audios Name.&transaction_type=912&survey_answer=1,2,3,4&audio_file=201205181032260.opcion1.wav,201205181032460.opcion2.wav,201205181033020.opcion3.wav,INTRO_EEB.wav&transaction_id=375885



Broadcast Audio Survey List Request (913)





campid Yes Integer Campaign id. question_id Yes Integer 0 to 30. description Yes String (100) Description of question.


Broadcast Audio Survey List Response (913)





transaction_type Integer Constant value = 913.

campaign_name String(50) Campaign Name. question_id Integer 0 to 30.




EDIT FILEDS



question_id Yes Integer 0 to 30. description Yes String (100) Description of question.



98

Broadcast Audio Survey List (913) - Example





$error = '';

//$file = "C:\\Temp\ question1.wav ";// Example For Windows

$audio_file = "/home/question1.wav";// Example For Linux




'user_id'=>'user',

'user_pw'=>'pass',

'product_id'=>99,

'campid'=>1233,

'question_id'=>1,

'description'=>'Question #1'

);

$ch = curl_init();






curl_close($ch);


?>



Broadcast Audio Survey List Response (913) -

Example


response_code=1&response_msg=Success&response_desc=Upload audio survey list Successful.&transaction_type=913&campaign_name=SURVEY LIST&question_id=1&audio_file=question1.wav&transaction_id=375901

100

Broadcast Audio Survey List Information Request

(914)




Broadcast Audio Survey List Information Response (914)






question_id String(50) Format VALUE example: question_id = 1 If is returned more of one answer_id is separated for comas. example: question_id = 1,2,3,4…30

audio_file Memo Format VALUE example: audio_file=question0.wav If is returned more of one Audio file is separated for comas. example: audio_file=question0.wav,question1.wav, question2.wav,question3.wav,question4.wav

description Format VALUE example: description= Question #0

If is returned more of one Audio file is separated for comas. example: description=Question #0,Question #1,Question #2, Question #3, Question #4




March 20, 2013 <index> 101

Broadcast Audio Survey List Information Request

(914) – Example

? transaction_type=914&user_id=user&user_pw=pass&campid=1233

Broadcast Audio Survey List Information Response (914) – Example response_code=1&response_msg=Success&response_desc=Returned question_id and Audios Name.&transaction_type=914&question_id=0,1,2,3,4&audio_file=201203221154360.PistaIVRDominosP1.wav,201203221154480.PistaIVRDominosP2.wav,201203221154580.PistaIVRDominosP3.wav,principal-encuesta.wav,INTRO_EEB.wav,INTRO_EEB.wav&description=Quiere Continuar,Quien realizo el pedido,Edad,Pregunta #3,Pregunta #4,Pregunta #5&transaction_id=375905

102

Response Codes & Messages

Code Description

0 Invalid Operation.

1 Success.

2 Server Error.

3 Parameter Expected.

4 Login Failed.

5 Type Mismatch.

6 Connection is non-secure.

7 IP Check Failed.

8 Operation Unsuccessful.

9 Account could not be found.

10 Credit Limit Reached.

11 Invalid Account Status.

12 Invalid Activation/DeActivation Request.

13 ANI is already registered.

14 PIN is being used by another ANI.

15 ANI could not be found.

16 Access Number could not be found.

17 Access Number/Account do not support this feature.

18 PIN is already registered.

19 Control Number is already registered.

20 There is no registered ANI under the account.

21 New PIN is not good.

22 Account already has this feature.

23 Insufficient Inventory.

24 Duplicate Attempt. (Duplicate request attempts are disregarded for some of the transaction types if they occur within the same minute)

25 Transaction Type is Blocked.

26 Product identifier could not be validated.

27 ANI is already registered under a different client.

28 SMS Campaign Not Found

29 Cannot Cancel Campaign SMS

30 Date Format Invalid.

31 Validation failed for field (account_password).

32 LEAD Disabled.

33 Number is Fixed

34 No routing found for this type of network

35 No senders found for this route

36 Message length is greater to 160 characters


March 20, 2013 103

Account Statuses

Code Description

1 Account is active.

0 Account is inactive.

3 Account has expired.

101 Account has been deactivated.

222 Account is destroyed.

Call Statuses

Code Description

1 Successfully Processed.

12 Invalid Phone Number.

13 Insufficient Account Balance.

101 Being Processed.

212 Invalid Origination Phone Number.


222 Invalid Destination Phone Number.


300 Unable to make call, system will try again in 2 mins.

301 CallBack time expired, unable to make call.

302 Account not WebCall-Enabled, contact customer support.

255 Not processed yet.

Ipcom webservices2

Documents

Transcript of Ipcom webservices2