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

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 transaction_type user_id

Required Yes Yes

Field Type Integer String (20)

user_pw

Yes

String (20)

field_delimeter

No

String (2)

column_delimeter

No

String (2)

response_type

No

String (2)

redirect_link

No

String (255)

March 20, 2013

Description Constant value (Transaction Type Codes) Unique identifier to each client to access the Web Service. IPCOM will provide this identifier to the client.

Password for the user_id. IPCOM will provide this identifier to the client.

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.

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.

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.

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.

<index>

3

Transaction Types Code 100

Transaction Type Account Creation

101

Account Information

102

Account Removal

103 104 105

Account Modification Account Activation Account Deactivation

106 201 301 302 400 401 402 403 404 405 700

Cdrs_export Recording Download Address Add Address Del Send Single SMS Create SMS Campaign Campaign SMS Status Cancel SMS Campaign SMS Export Report Info Balance SMS Get queues (centers)

800

Predictive Dialer Qualified Dispositions Predictive Dialer Program Creation

801 802 803 804 805 806 807 808 900 901 902 903 904 905 906 907

Predictive Dialer Program Information Predictive Dialer Program Modification Predictive Dialer Enable/Disable Predictive Dialer Upload Numbers Predictive Dialer Upload Multiples Contacts Predictive Dialer Queue Configuration Export numbers Broadcast Dialer List of Campaigns Broadcast Dialer Add Base Broadcast Dialer Information Broadcast Dialer Modification Broadcast Dialer Enable/Disable Broadcast Dialer Upload Numbers Broadcast Dialer Campaign Conf Broadcast Dialer Campaign Information

Transaction Description Creates a single account.

(If status_flag is not sent as "1" then the new account is created as a not-active account.)

Retrieves information about the specified account.

Erases an Account from the IPCOM System. * Not Enabled Yet Modify account parameters/information.

Activates the specified account.

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

Allow export the Cdr report Download a recording.

Add an address to openser DB. Remove an address from openser DB. Send a single SMS request.

Schelude a Campaign.

Campaign Status.

Cancel a requested schelude.

Allow export the report of campaign.

Info Balance.

Returns the centers represented by queues of each campaign.

Qualified Dispositions contacts.

View

View View View View View

View View View View View View View View View View View View

Create a campaign of predictive dialer.

View

Retrieves information about the specified campaign.

Modify campaign parameters/information.

View

Activated or Deactivated campaign.

Upload bases predictive dialer.

Upload multiples contacts predictive dialer.

View View View

Configure queues of campaign.

View

Allow export the report of campaign.

To select a campaign Broadcast.

View View

Add a base of Broadcast dialer.

Retrieves information about the specified base.

Modify base parameters/information.

Activated or Deactivated Bases.

Upload numbers dialer broadcast.

Configure of campaign.

Information of Campaign.

View View View View View View View

View

4

IPCOM NETWORKS © 2010 908 909 910 911 912 913

Broadcast Dialer Real Time Report Broadcast Dialer Export Report Broadcast Dialer Export CDR Broadcast Audio Survey Broadcast Audio Survey Info Broadcast Audio Survey List

914

Broadcast Audio Survey List Info

Real Time Report.

Report base Report CDR Add and Update Audio Campaign type Survey Information Campaign type Survey Add and Update Audio Campaign type Survey List Information Campaign type Survey List

View View View View View View View

Product Identifier Types Code

Product ID

March 20, 2013

Description

<index>

5

Account Creation Request (100) Field Name

Require d Yes

Type

Description

Integer

Constant value = 100

Yes

Integer

status_flag

No*

Integer

account_name

Yes

account_passw ord

No*

String (10) String (10)

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

Status of the new account to be created.

Constant value (0=deactive, 1=active). Default is 0.

10-Characters Account. Can be Letters or Numbers.

first_names

Yes

last_name

Yes

is_agent

No

is_supervisor is_monitor supervisor

Yes Yes No

monitor_groups

No

d_centro

Yes

String(1 0)

d_camp

Yes

reference_id

No

String(1 0) String (20)

transaction_typ e product_id

String(2 0) String(2 0) Integer Integer Integer String(1 0) String(1 00)

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 Can be first and middle name Last name Can login as an Agent in a Queue. (0=no, 1=yes).

Default is 0.

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

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

Account_name who supervise this account.

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

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

Campaign. This information has to be pre-provisioned

by IPCOM by written request.

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 response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

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

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

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

Constant value = 100 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.

6

IPCOM NETWORKS © 2010 product_id status_flag account_number account_passwo rd account_domain reference_id

Integer Integer String (10) String (10)

Echoed.

Echoed (or provided).

Echoed.

Echoed (or provided).

String (50) String (20)

Provided.

Echoed.

Account Creation Request (100) - Example

?transaction_type=100&product_id=99&user_id=user&user_pw=pass&account_name=2200&acc ount_password=jfkl34kdf&first_names=Felipe+Andres&last_name=Fonseca+Marin&is_superviso r=0&is_monitor=0&d_centro=c001&d_camp=admin&status_flag=1&is_agent=0&reference_id=22 01

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&ac count_password=jfkl34kdf&account_domain=c001.admin.test.ipcom.com&reference_id=2201&transaction_id=54934

March 20, 2013

<index>

7

Account Information Request (101) Field Name transaction_typ e account_name account_domain reference_id

Required Yes

Field Type Integer

Description Constant value = 101

Yes Yes

String (10) String (50)

Account Number Provided in the Account Creation Response

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 response_cod e response_msg response_des c transaction_ty pe transaction_id

Type Integer String (80) String (255) Integer Integer

status_flag

Integer

account_name

String (10) String (10) String(20) String(20) Integer Integer Integer String(10) String(10 0) String(10) String(10) String(10)

account_passw ord first_names last_name is_agent is_supervisor is_monitor supervisor monitor_group s d_centro d_camp d_subcamp

reference_id

String (20)

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

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

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

Constant value = 101 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.

Status of the new account to be created.

Constant value (0=deactive, 1=active). Default is 0.

10-Characters Account. Can be Letters or Numbers.

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

Can be first and middle name Last name Can login as an Agent in a Queue. (0=no, 1=yes). Default is 0.

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

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

Account_name who supervise this account.

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

Centro or Location where this account resides Campaign Additional information about the camping.

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

8

IPCOM NETWORKS © 2010

Account Information Request (101) - Example ?transaction_type=101&user_id=user&user_pw=pass&account_name=fafonseca&account_doma in=c001.admin.test.ip-com.com

Account Information Response (101) – Example response_code=1&response_msg=Success&response_desc=Dislplaying account fafonseca infor mation.&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&i s_supervisor=0&is_monitor=0&supervisor=&monitor_groups=&d_centro=acap&d_camp=banc&d _subcamp=venta&transaction_id=1128

March 20, 2013

<index>

9

Account Removal Request (102) Field Name transaction_type account_name account_domain reference_id

Required Yes Yes Yes No

Field Type Integer String (10) String (50) String (20)

Description Constant value = 102 Account Name Provided in the Account Creation Response Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Account Removal Response (102) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 102 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.

Echoed.

10

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

11

Account Modification Request (103) Field Name transaction_type account_name account_domain reference_id

Required Yes Yes Yes No

Field Type Integer String (10) String (50) String (20)

Description Constant value = 103 Account Name Provided in the Account Creation Response Reference identifier assigned by client.

Account Modification Response (103) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type account_name account_domain transaction_id

Integer String (10) String (50) Integer

reference_id

String (20)

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

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

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

Constant value = 103 Account Name Account Domain Unique number assigned by IPCOM to identify the transaction in the system.

Echoed.

Editable Fields Field Name status_flag account_passwor d first_names last_name is_agent

Type Integer String (10) String(20) String(20) Integer

is_supervisor is_monitor supervisor monitor_groups

Integer Integer String(10) String(100 )

d_centro

String(10)

d_camp

String(10)

reference_id

String (20)

Description Constant value (0=deactive, 1=active).

Password Can be first and middle name Last name Can login as an Agent in a Queue. (0=no, 1=yes). Default is 0.

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

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

Account_name who supervise this account.

Account_names who can monitor this account.

Values must be separated by coma. Example: jdoe, ckent, agonzalez.

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

Campaign. This information has to be preprovisioned by IPCOM by written request.

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

12

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

13

Account Activation Request (104) Field Name transaction_type account_name account_domain reference_id

Required Yes Yes Yes No

Field Type Integer String (10) String (50) String (20)

Description Constant value = 104 Account Name Provided in the Account Creation Response Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Account Activation Response (104) Field Name

Field Type

Description

response_code

Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 104 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.

Echoed.

14

IPCOM NETWORKS © 2010

Account Activation Request (104) – Example

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

Account Activation Response (104) – Example response_code=1&response_msg=Success&response_desc=Account fafonseca activat ed correctly.&transaction_type=104&reference_id=&transaction_id=1118

March 20, 2013

<index>

15

Account Deactivation Request (105) Field Name transaction_type account_name account_domain reference_id

Required Yes Yes Yes No

Type Integer String(10) String(50) String(20)

Description Constant value = 105 Account Name Provided in the Account Creation Response 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) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 105 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.

Echoed.

16

IPCOM NETWORKS © 2010

Account Deactivation Request (105) - Example ?transaction_type=105&user_id=user&user_pw=pass&account_name=fafonseca&account_doma in=acap.banc_venta.cust.domain.com

Account Deactivation Response (105) - Example response_code=1&response_msg=Success&response_desc=Account fafonseca deactivated cor rectly.&transaction_type=105&reference_id=&transaction_id=1117

March 20, 2013

<index>

17

CDRS Export Request (106) Field Name transaction_type product_id

Required Yes Yes

Type Integer String(10)

d_camp

Yes

String(10)

d_centro

No

String(10)

reference_id

No

String(20)

Description Constant value = 106 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign. This information has to be preprovisioned by IPCOM by written request.

Centro or Location where this account resides.

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

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

CDRS Export Response (106) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type filename url

Integer String(50) String (100)

reference_id

String (20)

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

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

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

Constant value = 106 File Name export Link for export file eg: https://ws.ip-com.com/exported/export-base4107.csv Echoed.

18

IPCOM NETWORKS © 2010

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-0301.csv&url=https://ws.ip-com.com/exported/export-cdrs-c001-admin-2013-0301.csv&reference_id=&transaction_id=641093

March 20, 2013

<index>

19

Download a Recording Request (201)

transaction_type product_id

Requi red Yes Yes

cid reference_id

Yes No

Field Name

Type

Description

Integer Integer

Constant value = 201 Product identifier. Please ask IPCOM for a list of product_id values.

Call identifier.

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

Integer String(2 0)

Download a Recording Response (201) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

protocol host port filename transaction_type transaction_id

Integer Integer

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

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

Brief description of the result, which corresponds with the Response Code. http host port Filename to be downloaded Constant value = 201 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.

20

IPCOM NETWORKS © 2010

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=20 12/03/21/15/20120321-153055-113336318968@65.208.88.91127873@c004.rda.mc.xhosteos.com-NFQ.wav&transaction_id=296901

March 20, 2013

<index>

21

Address Add To Openser DB Request (301) Field Name transaction_type ip reference_id

Required Yes Yes No

Type Integer String(50) String(20)

Description Constant value = 301 IP address to add Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Address Add To Openser DB Response (301) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 301 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.

Echoed.

22

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

23

Remove an address from openser DB Request (302) Field Name transaction_type ip reference_id

Required Yes Yes No

Type Integer String(50) String(20)

Description Constant value = 302 IP address to add Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Remove an address from openser DB Response (302) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 302 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.

Echoed.

24

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

25

Send Single SMS Request (400) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

number

Yes

Integer

msg reference_id

Yes No

String (160) String (20)

Description Constant value = 400 Product identifier. Please ask IPCOM for a list of product_id values for sms.

Telephone number where the message will be sent The message to be sent 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) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

rate balance transaction_type transaction_id

Double(8,4) Double(8,4) Integer Integer

reference_id

String (20)

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

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

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

Rate dispatch of sms Customer Credit Constant value = 400 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.

Echoed.

26

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

27

Create SMS Campaign Request (401) Field Name file

Required Yes

Field Type *.csv

transaction_type product_id

Yes Yes

Integer Integer

campaign_name country

Yes Yes

String (50) Integer

date_schedule_sms

Yes

String (20)

msg reference_id

Yes No

String (160) String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 401.

File size should not exceed 10 MB. Constant value = 401 Product identifier. Please ask IPCOM for a list of product_id values for sms.

Campaign name example: news SMS 55 -> Brasil 573 - >Colombia 52 -> México 519 -> Perú 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 The message to be sent Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Create SMS Campaign Response (401) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

campid

Integer

balance Upload_numbers transaction_type transaction_id

Double(8,4) Integer Integer Integer

reference_id

String (20)

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

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

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

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 New Customer Credit Amount of numbers uploaded Constant value = 401 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.

Echoed.

28

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

29

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>'; ?>

30

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

31

Campaign Status SMS Request (402) Field Name transaction_type campid

Required Yes Yes

Field Type Integer Integer

reference_id

No

String (20)

Description Constant value = 402 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 Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Campaign Status SMS Response (402) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 402 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.

Echoed.

32

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

33

Cancel SMS Scheduled Campaign Request (403) Field Name transaction_type campid

Required Yes Yes

Field Type Integer Integer

reference_id

No

String (20)

Description Constant value = 403 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 Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Cancel SMS Scheduled Campaign Response (403) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 403 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.

Echoed.

34

IPCOM NETWORKS © 2010

Cancel SMS Scheduled Campaign Request (403) Example ?transaction_type=403&user_id=user&user_pw=pass&campid=15

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

March 20, 2013

<index>

35

SMS Export Report Request (404) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

campid

Yes

integer

reference_id

No

String (20)

Description Constant value = 404 Product identifier. Please ask IPCOM for a list of product_id values for sms.

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

SMS Export Report Response (404) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type filename url

Integer String(50) String (100)

total_numbers fixed_numbers delivered_numbers reference_id

Integer Integer Integer String (20)

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

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

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

Constant value = 404 File Name export.

Link for export file eg: https://ws.ip-com.com/exported/exportreport-sms-15.csv Amount of processed numbers.

Amount of fixed numbers.

Numbers delivered.

36

IPCOM NETWORKS © 2010

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.ipcom.com/exported/export-report-sms15.csv&total_numbers=15&fixed_numbers=0&delivered_numbers=15&reference_id=&transaction _id=398233

March 20, 2013

<index>

37

Info Balance SMS Request (405) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

reference_id

No

String (20)

Description Constant value = 405 Product identifier. Please ask IPCOM for a list of product_id values for sms.

Info Balance SMS Response (405) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type name_user balance reference_id

Integer String(20) Double(8,4) String (20)

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

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

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

Constant value = 405 Customer Name Customer Credit

38

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

39

Get Queues (Centers) Request (700) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

d_center

No

String (10)

d_camp

No

String (10)

reference_id

No

String (20)

Description Constant value = 700 Product identifier. Please ask IPCOM for a list of product_id values.

Center filter. This information has to be preprovisioned by IPCOM by written request.

If d_center = % returned all Campaign filter. This information has to be preprovisioned by IPCOM by written request.

If d_camp= % returned all Reference identifier assigned by client. This value is recorded for reporting purposes, and will also be passed back in the response.

Get Queues (Centers) Response (700) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type queue

Integer String(255)

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

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

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

Constant value = 700 Format VALUE;DESCRIPTION example: c001.wp.test;Admin C001-webphone If is returned more of one center is separated for coma. example:

transaction_id

Integer

reference_id

String (20)

c001.wp.test;Admin C001-webphone, c001.admin.test;Admin C001-Admin, c001.ad.test;Admin C001-Ad 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.

Echoed.

40

IPCOM NETWORKS © 2010

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=w p 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 C001webphone&transaction_id=359583 Only center filter: response_code=1&response_msg=Success&response_desc=returned centers.&transaction_type=700&queue=c001.admin.test;Admin C001Admin,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 C001webphone&transaction_id=359585 Any filter: response_code=1&response_msg=Success&response_desc=returned centers.&transaction_type=700&queue=c001.admin.test;Admin C001Admin,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 C001webphone,cba.admin.test;BARRANQUILLA-Admin,cba.czlla.test;BARRANQUILLACallzilla,cba.ca.test;BARRANQUILLA-Cartera,cba.oa.test;BARRANQUILLAoreka,cba.si.test;BARRANQUILLA-Solati,cba.wp.test;BARRANQUILLAwebphone,c02.admin.test;Colombia Center-Admin,c02.czlla.test;Colombia CenterCallzilla,c02.ca.test;Colombia Center-Cartera,c02.oa.test;Colombia Centeroreka,c02.si.test;Colombia Center-Solati, c003.czlla.test;Medellin-Callzilla,c003.ca.test;MedellinCartera,c003.oa.test;Medellin-oreka,c003.si.test;Medellin-Solati,c003.wp.test;Medellinwebphone&transaction_id=359589

March 20, 2013

<index>

41

Predictive Qualified Dispositions Request (800) Field Name transaction_type cid

Required Yes Yes

Field Type Integer Integer

number redial_contact

Yes Yes

Integer Integer

status_contact

Yes

Integer

reference_id

No

String (20)

Description Constant value = 800 Call identifier. popup url, return (cid) field Ej: cid=21105533 Phone number to qualify 0 - No redial.

1 - Redial LEAD. 0 - Disables the Contact.

1 - Remains active Contact.

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

Predictive Qualified Dispositions Response (800) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type transaction_id

Integer Integer

reference_id

String (20)

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

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

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

Constant value = 800 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.

Echoed.

42

IPCOM NETWORKS © 2010

Predictive Qualified Dispositions Request (800) Example No redial: ?transaction_type=800&user_id=user&user_pw=pass&cid=21105533&number=5717423407&red ial_contact=0&status_contact=0 Redial + Disabled contact: ?transaction_type=800&user_id=user&user_pw=pass&cid=21105533&number=5717423407&red ial_contact=1&status_contact=0 Redial + Remains active Contact: ?transaction_type=800&user_id=user&user_pw=pass&cid=21105533&number=5717423407&red ial_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

March 20, 2013

<index>

43

Predictive Program Creation Request (801) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

campaign_name campaign_type

Yes Yes

String (50) Integer

progresivo

Yes

integer

datetime_init

Yes

String (20)

datetime_end

Yes

String (20)

daytime_init

Yes

String (8)

daytime_end

Yes

String (8)

based_on_ASR

Yes

integer

retries call_timeout

Yes Yes

integer integer

queue

Yes

String (30)

Description Constant value = 801 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign Name 1 -> Predictive Dialer 2 -> Manual Dialer 0 -> Inactive (Default) 1 -> Activate Start date eg: 2012-07-17 End date eg: 2012-07-25 Start Hour eg: 00:00:00 End Hour eg: 20:00:00 0 -> Inactive 1 -> Activate (Default) Number of retries 0 - 20 Call Timeout (seconds) 70 -> Default 15 -> Min. 240 -> Max. The Format of queue is: VALUE;DESCRIPTION queue = c001.wp.test;Admin C001-webphone

in this field should only enter the value: custom_url

No

String (255)

script reference_id

No* No

Memo String (20)

VALUE is => c001.wp.test NOTE: for the page to be re routed properly, it is required to include the (http://) + domain (www.google.com) .

A small training text for the agent.

Predictive Program Creation Response (801) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campid campaign_name transaction_id

Integer integer String (50) Integer

reference_id

String (20)

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

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

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

Constant value = 801 Campaign id Campaign Name created Unique number assigned by IPCOM to identify the transaction.

Echoed.

44

IPCOM NETWORKS © 2010

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&dateti me_end=2012-07-17&datetime_init=2012-0722&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

March 20, 2013

<index>

45

Predictive Program Information Request (802) Field Name transaction_type campid product_id

Required Yes Yes Yes

Field Type Integer integer Integer

reference_id

No

String (20)

Description Constant value = 802 Campaign id Product identifier. Please ask IPCOM for a list of product_id values.

Predictive Program Information Response (802) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type product_id campaign_name campaign_type progresivo datetime_init datetime_end daytime_init daytime_end based_on_ASR retries call_timeout queue custom_url script transaction_id

Integer Integer String (50) Integer integer String (20) String (20) String (8) String (8) integer integer integer String (30) String (255) Memo integer

reference_id

String (20)

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

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

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

Constant value = 802 Product identifier.

Campaign Name Campaign Type Progresive Start date End date Start Hour End Hour Based on ASR Number of Retries Call Timeout (seconds) Queue Eg: c001.wp.test URL Eg: http://www.google.com A small training text for the agent.

Unique number assigned by IPCOM to identify the transaction.

Echoed.

46

IPCOM NETWORKS © 2010

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-0722&datetime_end=2012-0717&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

March 20, 2013

<index>

47

Predictive Program Modification Request (803) Field Name transaction_type campid product_id

Required Yes Yes Yes

Field Type Integer Integer Integer

reference_id

No

String (20)

Description Constant value = 803 Campaign id Product identifier. Please ask IPCOM for a list of product_id values.

Predictive Program Modification Response (803) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campid campaign_name

campaign_modified

Integer integer String (50) String (20)

transaction_id

Integer

reference_id

String (20)

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

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

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

Constant value = 803 Campaign id Campaign Name created Date modification Unique number assigned by IPCOM to identify the transaction.

Echoed.

48

IPCOM NETWORKS © 2010

Editable Fields Field Name campaign_name campaign_type

Required No No

Field Type String (50) Integer

campaign_status

No

String (1)

progresivo

No

integer

datetime_init

No

String (20)

datetime_end

No

String (20)

daytime_init

No

String (8)

daytime_end

No

String (8)

based_on_ASR

No

integer

retries call_timeout

No No

integer integer

queue

No

String (30)

Description Campaign Name 1 -> Predictive Dialer 2 -> Manual Dialer A -> activated T -> deactivated 0 -> Inactive (Default) 1 -> Activate Start date eg: 2012-07-17 End date eg: 2012-07-25 Start Hour eg: 00:00:00 End Hour eg: 20:00:00 0 -> Inactive 1 -> Activate (Default) Number of retries 0 - 20 Call Timeout (seconds) 70 -> Default 15 -> Min. 240 -> Max. The Format of queue is eg: VALUE;DESCRIPTION queue = c001.wp.test;Admin C001-webphone

in this field should only enter the value: custom_url

No

String (255)

script reference_id

No No

Memo String (20)

March 20, 2013

VALUE is => c001.wp.test NOTE: for the page to be re routed properly, it is required to include the (http://) + domain (www.google.com) .

A small training text for the agent.

<index>

49

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-0722&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

50

IPCOM NETWORKS © 2010

Predictive Dialer Enabled / Disabled Request (804) Field Name transaction_type campid product_id

Required Yes Yes Yes

Field Type Integer Integer Integer

campaign_status

No

String (1)

reference_id

No

String (20)

Description Constant value = 804 Campaign id Product identifier. Please ask IPCOM for a list of product_id values.

A -> activated T -> deactivated

Predictive Dialer Enabled / Disabled Response (804) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campid campaign_name campaign_modified transaction_id

Integer integer String (50) String (20) Integer

reference_id

String (20)

March 20, 2013

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

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

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

Constant value = 804 Campaign id Campaign Name created Date modification Unique number assigned by IPCOM to identify the transaction.

Echoed.

<index>

51

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

52

IPCOM NETWORKS © 2010

Predictive Upload Numbers Request (805) Field Name file

Required Yes

Field Type *.csv

transaction_type product_id

Yes Yes

Integer Integer

campid reference_id

Yes No

Integer String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 805 File size should not exceed 10 MB Constant value = 805 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

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

Predictive Upload Numbers Response (805) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type upload_numbers transaction_id

Integer Integer Integer

reference_id

String (20)

March 20, 2013

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

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

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

Constant value = 805 Amount of numbers uploaded 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.

Echoed.

<index>

53

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 PARAMETERS ,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

EXAMPLE FORMAT FILE ONLY NUMBERS 573202740434 573115355044 573204419350 573202640494 573202740424

54

IPCOM NETWORKS © 2010

Predictive Upload Numbers Request (805) - Example The client must pass data through the use of the library curl as shown in the 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 $upload_url = "http://ws.ip-com.com"; $data = array('file' => "@$file", 'transaction_type'=>805, 'user_id'=>'user', 'user_pw'=>'pass', 'product_id'=>99, 'campid'=>5007 );

$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>'; ?>

March 20, 2013

<index>

55

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

56

IPCOM NETWORKS © 2010

Predictive Upload Multiples Contacts Request (806) Field Name file

Required Yes

Field Type *.csv

transaction_type product_id

Yes Yes

Integer Integer

campid reference_id

Yes No

Integer String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 806.

File size should not exceed 10 MB. Constant value = 806 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

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

Predictive Upload Multiples Contacts Response (806) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type inserted lines transaction_id

Integer Integer Integer Integer

reference_id

String (20)

March 20, 2013

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

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

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

Constant value = 806 Amount of numbers inserted Amount of lines uploaded 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.

Echoed.

<index>

57

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 PARAMETERS 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

58

IPCOM NETWORKS © 2010

Predictive Upload Numbers Request (806) - Example The client must pass data through the use of the library curl as shown in the example: <? error_reporting(E_ALL); ini_set('display_errors','On'); //error_reporting (E_ALL ^ E_NOTICE); $error = ''; //$file = "C:\\Temp\ multiplescontacts.csv ";// Example For Windows $file = "/home/multiplescontacts.csv";// Example For Linux $upload_url = "http://ws.ip-com.com"; $data = array('file' => "@$file", 'transaction_type'=>806, 'user_id'=>'user', 'user_pw'=>'pass', 'product_id'=>99, 'campid'=>5109 );

$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>'; ?>

March 20, 2013

<index>

59

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

60

IPCOM NETWORKS © 2010

Predictive Configuration Queues Request (807) Field Name

Required

Field Type

Description Constant value = 807 Queue of campaign eg: c001.wp.test How long do we let the phone ring before we consider this a Timeout?

Timeout in seconds when calling an agent

transaction_type queue

Yes Yes

Integer String(128)

timeout

No

Integer

retry

No

Integer

wrapuptime

No

Integer

strategy

No

String(20)

March 20, 2013

timeout=15 How long do we wait before trying all the members again? retry = 5 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) 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

<index>

61

memberdelay

No

Integer

timeoutrestart

No

Integer

reference_id

No

String (20)

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 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) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type queue

Integer String(128)

transaction_id

Integer

reference_id

String (20)

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

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

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

Constant value = 807 Queue of campaign eg: c001.wp.test Unique number assigned by IPCOM to identify the transaction.

Echoed.

62

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

63

Predictive Export Numbers Request (808) Field Name transaction_type product_id

Required Yes Yes

Type Integer String(10)

campid reference_id

Yes No

Integer String(20)

Description Constant value = 808 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

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) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type filename url

Integer String(50) String (100)

reference_id

String (20)

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

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

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

Constant value = 808 File Name export Link for export file eg: https://ws.ip-com.com/exported/export-base4107.csv Echoed.

64

IPCOM NETWORKS © 2010

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.ipcom.com/exported/export_camp_1381.csv&reference_id=&transaction_id=641109

March 20, 2013

<index>

65

Broadcast Dialer - List of Campaigns Request (900) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

reference_id

No

String (20)

Description Constant value = 900 Product identifier. Please ask IPCOM for a list of product_id values.

Broadcast Dialer - List of Campaigns Response (900) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campid

Integer String (255)

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

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

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

Constant value = 900 Format VALUE;DESCRIPTION example: 1235;PRUEBA If is returned more of one campaign id is separated for comas. example:

transaction_id

Integer

reference_id

String (20)

1235;PRUEBA, 1233;SURVEY LIST, 1279;SURVEY TEST Unique number assigned by IPCOM to identify the transaction.

Echoed.

66

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

67

Broadcast Dialer Add Base Request (901) Field Name transaction_type campid

Required Yes Yes

Field Type Integer Integer

product_id

Yes

Integer

datetime_init

Yes

String (20)

datetime_end

Yes

String (20)

daytime_init

Yes

String (8)

daytime_end

Yes

String (8)

reference_id

No

String (20)

Description Constant value = 901 Campaign Id eg: campid=1235 Product identifier. Please ask IPCOM for a list of product_id values.eg: product_id=99 Start date eg: 2012-07-17 End date eg: 2012-07-25 Start Hour eg: 00:00:00 End Hour eg: 20:00:00

Broadcast Dialer Add Base Response (901) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campid base_id base text_notes transaction_id

Integer Integer Integer String (20) Memo Integer

reference_id

String (20)

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

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

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

Constant value = 901 Campaign Id Base id Base Name Notes Unique number assigned by IPCOM to identify the transaction.

Echoed.

68

IPCOM NETWORKS © 2010

Broadcast Dialer Add Base Request (901) - Example ?transaction_type=901&user_id=user&user_pw=pass&campid=1235&product_id=99&datetime_i nit=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_no tes=create -> 2012-07-30 13:48:04&transaction_id=363773

March 20, 2013

<index>

69

Broadcast Dialer Information Request (902) Field Name transaction_type base_id reference_id

Required Yes Yes No

Field Type Integer integer String (20)

Description Constant value = 902 Base Id

Broadcast Dialer Information Response (902) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type base status

Integer String (20) Integer

datetime_init datetime_end daytime_init daytime_end factor text_notes

String (20) String (20) String (8) String (8) Float Memo

transaction_id

integer

reference_id

String (20)

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

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

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

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

Start date End date Start Hour End Hour Eg: 1.2 A small text that summarizes the changes that have taken place at the base.

Unique number assigned by IPCOM to identify the transaction.

Echoed.

70

IPCOM NETWORKS © 2010

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-0717&datetime_end=2012-0717&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

March 20, 2013

<index>

71

Broadcast Dialer Modification Request (903) Field Name transaction_type base_id reference_id

Required Yes Yes No

Field Type Integer Integer String (20)

Description Constant value = 903 Base id

Broadcast Dialer Modification Response (903) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type base_id base transaction_id

Integer integer String (20) Integer

reference_id

String (20)

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

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

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

Constant value = 903 Base Id Base Name Unique number assigned by IPCOM to identify the transaction.

Echoed.

EDIT FILEDS Field Name status

Required No

Field Type Integer

datetime_init

No

String (20)

datetime_end

No

String (20)

daytime_init

No

String (8)

daytime_end

No

String (8)

reference_id

No

String (20)

Description 1 -> activated 0 -> deactivated Start date eg: 2012-07-17 End date eg: 2012-07-25 Start Hour eg: 00:00:00 End Hour eg: 20:00:00

72

IPCOM NETWORKS © 2010

Broadcast Dialer Modification Request (903) Example ?transaction_type=903&user_id=user&user_pw=pass&base_id=3561&status=1&datetime_init=2 012-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

March 20, 2013

<index>

73

Broadcast Dialer Enabled / Disabled Request (904) Field Name transaction_type base_id status

Required Yes Yes No

Field Type Integer Integer Integer

reference_id

No

String (20)

Description Constant value = 904 Base id 1 -> activated 0 -> deactivated

Broadcast Dialer Enabled / Disabled Response (904) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type base_id base transaction_id

Integer integer String (20) Integer

reference_id

String (20)

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

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

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

Constant value = 904 Base Id Base Name Unique number assigned by IPCOM to identify the transaction.

Echoed.

74

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

75

Broadcast Dialer Upload Numbers Request (905) Field Name file

Required Yes

Field Type *.csv

transaction_type product_id

Yes Yes

Integer Integer

campid base_id reference_id

Yes Yes No

Integer Integer String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 905.

File size should not exceed 30 MB. Constant value = 905 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

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

Broadcast Dialer Upload Numbers Response (905) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type text_notes transaction_id

Integer Memo Integer

reference_id

String (20)

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

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

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

Constant value = 905 Date and quantity loaded or duplicate numbers, if any.

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.

Echoed.

76

IPCOM NETWORKS © 2010

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 PARAMETERS ,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

EXAMPLE FORMAT FILE ONLY NUMBERS 573202740434 573115355044 573204419350 573202640494 573202740424

March 20, 2013

<index>

77

Broadcast Dialer Upload Numbers Request (905) Example The client must pass data through the use of the library curl as shown in the example: <? error_reporting(E_ALL); ini_set('display_errors','On'); //error_reporting (E_ALL ^ E_NOTICE); $error = ''; //$file = "C:\\Temp\ upload_numbers_dbroadcast.csv ";// Example For Windows $file = "/home/upload_numbers_dbroadcast.csv";// Example For Linux $upload_url = "http://ws.ip-com.com"; $data = array('file' => "@$file", 'transaction_type'=>905, 'user_id'=>'user', 'user_pw'=>'pass', 'product_id'=>99, 'campid'=>1235, 'base_id'=>3561 );

$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>'; ?>

78

IPCOM NETWORKS © 2010

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

March 20, 2013

<index>

79

Broadcast Dialer Campaign Conf Request (906) Field Name audio_file

Required Yes

Field Type *.wav,*.mp3

transaction_type product_id

Yes Yes

Integer Integer

campid reference_id

Yes No

Integer String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 906 File size should not exceed 5 MB Constant value = 906 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

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

Broadcast Dialer Campaign Conf Response (906) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type audio_file transaction_id

Integer String (255) Integer

reference_id

String (20)

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

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

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

Constant value = 906 File name uploaded.

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.

Echoed.

80

IPCOM NETWORKS © 2010

EDIT FILEDS Field Name campaign_name status

Required No No

Field Type String(50) Integer

campaign_type

No

Integer

max_sim_calls

No

Integer

max_contact_rati o

No

Double(2,2)

retries

No

Integer

time_between_att emps

No

Integer

transfer reference_id

No* No

String(20) String (20)

Description Campaign Name 1 -> activated (Default) 0 -> deactivated 0 -> Audio Broadcast (Default) 1 -> Survey 3 -> Transfer 4 -> Survey List Simultaneos Calls.

0 -> Min (Default) 100 -> Max Radio contact % eg: 99.99 70.00 -> (Default) 1.00 -> Min 99.99 -> Max 1 to 5 1 -> Min (Default) 5 -> Max 1 to 300 minutes 1 -> Min (Default) 300 -> Max 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.

March 20, 2013

<index>

81

Broadcast Dialer Campaign Conf Request (906) Example The client must pass data through the use of the library curl as shown in the example: <? error_reporting(E_ALL); ini_set('display_errors','On'); //error_reporting (E_ALL ^ E_NOTICE); $error = ''; //$file = "C:\\Temp\ principal-encuesta.wav ";// Example For Windows $audio_file = "/home/principal-encuesta.wav";// Example For Linux $upload_url = "http://ws.ip-com.com"; $data = array('file' => "@$audio_file", 'transaction_type'=>906, '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_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>'; ?>

82

IPCOM NETWORKS © 2010

Broadcast Dialer Campaign Conf Response (906) 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=Update Campaign (BROADCAST WS) Successful.&transaction_type=906&audio_file=principalencuesta.wav&transaction_id=372519

March 20, 2013

<index>

83

Broadcast Dialer Campaign Information Request (907) Field Name transaction_type campid reference_id

Required Yes Yes No

Field Type Integer integer String (20)

Description Constant value = 907 Campaign id.

Broadcast Dialer Campaign Information Response (907) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type campaign_name status campaign_type max_sim_calls max_contact_ratio retries time_between_atte mps transfer reference_id

Integer String(50) Integer Integer Integer Double(2,2) Integer Integer String(20) String (20)

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

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

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

Constant value = 907 Campaign Name Status of campaign Campaign Type Simultaneos Calls.

Radio contact % eg: 99.99 Attemps.

Time Between Attemps.

Only if campaign type is of transfer

84

IPCOM NETWORKS © 2010

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&retrie s=1&time_between_attemps=2&transaction_id=367319

March 20, 2013

<index>

85

Broadcast Dialer Real Time Report Request (908) Field Name transaction_type product_id

Required Yes Yes

Field Type Integer Integer

base_id reference_id

Yes No

integer String (20)

Description Constant value = 908 Product identifier. Please ask IPCOM for a list of product_id values.

Base Id

Broadcast Dialer Real Time Report Response (908) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type campaign_name since until status max_sim_calls numbers queued dialed answered contact asr

Integer String(50) String (20) String (20) Integer Integer Integer Integer String(20) Integer Decimal(3,2) Decimal(3,2)

retries time_between_atte mps wait_for_answer reference_id

Integer Integer String (20)

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

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

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

Constant value = 908 Campaign Name Date / Time of Start Date / Time of Completion Status Simultaneos Calls configured Amount numbers Amount numbers in queued Amount of dialed numbers Amount of answered calls Radio contact % eg: 99.99 Measures the percentage of calls connected compared to total calls made.

Configured number of attempts Time between attempts configured in minutes wait for answer in seconds

86

IPCOM NETWORKS © 2010

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.

March 20, 2013

<index>

87

Broadcast Dialer Export Report Request (909) Field Name transaction_type base_id f_type_exp

Required Yes Yes Yes

Field Type Integer integer Integer

reference_id

No

String (20)

Description Constant value = 909 Base Id 1 -> CSV 2 -> CSV WITH ATTRIBUTES

Broadcast Dialer Export Report Response (909) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type filename url

Integer String(50) String (100)

reference_id

String (20)

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

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

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

Constant value = 909 File Name export Link for export file eg: https://ws.ip-com.com/exported/export-base4107.csv

88

IPCOM NETWORKS © 2010

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.ipcom.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.

March 20, 2013

<index>

89

Broadcast Dialer Export CDR Report Request (910) Field Name transaction_type base_id reference_id

Required Yes Yes No

Field Type Integer integer String (20)

Description Constant value = 910 Base Id

Broadcast Dialer Export CDR Report Response (910) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type filename url

Integer String(50) String (100)

reference_id

String (20)

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

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

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

Constant value = 910 File Name export Link for export file eg: https://ws.ip-com.com/exported/export-base4101-CDR.csv

90

IPCOM NETWORKS © 2010

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.ipcom.com/exported/export-base-4101-CDR.csv&transaction_id=373483

March 20, 2013

<index>

91

Broadcast Audio Survey Request (911) Field Name audio_file

Required Yes

Field Type *.wav

transaction_type product_id

Yes Yes

Integer Integer

campid survey_answer reference_id

Yes Yes No

Integer Integer String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 911 File size should not exceed 5 MB Constant value = 911 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

0 to 9.

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

Broadcast Audio Survey Response (911) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campaign_name

Integer String(50)

survey_answer audio_file transaction_id

Integer String (255) Integer

reference_id

String (20)

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

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

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

Constant value = 911.

Campaign Name.

0 to 9.

File name uploaded.

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.

Echoed.

EDIT FILEDS Field Name audio_file

Required Yes

Field Type *.wav

survey_answer reference_id

Yes No

Integer String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 911 File size should not exceed 5 MB 0 to 9.

92

IPCOM NETWORKS © 2010

Broadcast Audio Survey (911) - Example The client must pass data through the use of the library curl as shown in the example: <? error_reporting(E_ALL); ini_set('display_errors','On'); //error_reporting (E_ALL ^ E_NOTICE); $error = ''; //$file = "C:\\Temp\ answer1.wav ";// Example For Windows $audio_file = "/home/answer1.wav";// Example For Linux $upload_url = "http://ws.ip-com.com"; $data = array('file' => "@$audio_file", 'transaction_type'=>911, 'user_id'=>'user', 'user_pw'=>'pass', 'product_id'=>99, 'campid'=>1279, 'survey_answer'=>1 ); $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>'; ?>

March 20, 2013

<index>

93

Broadcast Audio Survey Response (911) - 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 audio survey Successful.&transaction_type=911&campaign_name=SURVEY_TEST&survey_answer=1&audio _file=answer1.wav&transaction_id=375831

94

IPCOM NETWORKS © 2010

Broadcast Audio Survey Information Request (912) Field Name transaction_type campid reference_id

Required Yes Yes No

Field Type Integer integer String (20)

Description Constant value = 912 Campaign id.

Broadcast Audio Survey Information Response (912) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type survey_answer

Integer String(50)

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

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

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

Constant value = 912 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,20120518103 2460.opcion2.wav,201205181033020.opcion3.wav,INTR O_EEB.wav

reference_id

March 20, 2013

String (20)

<index>

95

Broadcast Audio Survey Information Request (912) – Example ?transaction_type=912&user_id=user&user_pw=pass&campid=1279

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.w av,201205181032460.opcion2.wav,201205181033020.opcion3.wav,INTRO_EEB.wav&transactio n_id=375885

96

IPCOM NETWORKS © 2010

Broadcast Audio Survey List Request (913) Field Name audio_file

Required Yes

Field Type *.wav

transaction_type product_id

Yes Yes

Integer Integer

campid question_id description reference_id

Yes Yes Yes No

Integer Integer String (100) String (20)

Description Path file, this parameter should be used as shown in the example of the transaction request 913 File size should not exceed 5 MB Constant value = 913 Product identifier. Please ask IPCOM for a list of product_id values.

Campaign id.

0 to 30.

Description of question.

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

Broadcast Audio Survey List Response (913) Field Name response_code

Field Type Integer

response_msg

String (80)

response_desc

String (255)

transaction_type campaign_name

Integer String(50)

question_id audio_file transaction_id

Integer String (255) Integer

reference_id

String (20)

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

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

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

Constant value = 913.

Campaign Name.

0 to 30.

File name uploaded.

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.

Echoed.

EDIT FILEDS Field Name audio_file

Required Yes

Field Type *.wav

question_id description reference_id

Yes Yes No

Integer String (100) String (20)

March 20, 2013

Description Path file, this parameter should be used as shown in the example of the transaction request 913 File size should not exceed 5 MB 0 to 30.

Description of question.

<index>

97

Broadcast Audio Survey List (913) - Example The client must pass data through the use of the library curl as shown in the example: <? error_reporting(E_ALL); ini_set('display_errors','On'); //error_reporting (E_ALL ^ E_NOTICE); $error = ''; //$file = "C:\\Temp\ question1.wav ";// Example For Windows $audio_file = "/home/question1.wav";// Example For Linux $upload_url = "http://ws.ip-com.com"; $data = array('file' => "@$audio_file", 'transaction_type'=>913, 'user_id'=>'user', 'user_pw'=>'pass', 'product_id'=>99, 'campid'=>1233, 'question_id'=>1, 'description'=>'Question #1' ); $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>'; ?>

98

IPCOM NETWORKS © 2010

Broadcast Audio Survey List Response (913) 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 audio survey list Successful.&transaction_type=913&campaign_name=SURVEY LIST&question_id=1&audio_file=question1.wav&transaction_id=375901

March 20, 2013

<index>

99

Broadcast Audio Survey List Information Request (914) Field Name transaction_type campid reference_id

Required Yes Yes No

Field Type Integer integer String (20)

Description Constant value = 914 Campaign id.

Broadcast Audio Survey List Information Response (914) Field Name response_code

Field Type integer

response_msg

String (80)

response_desc

String (255)

transaction_type question_id

Integer String(50)

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

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

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

Constant value = 914 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 Format VALUE example: description= Question #0

description

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

String (20)

100

IPCOM NETWORKS © 2010

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.PistaIVRDo minosP1.wav,201203221154480.PistaIVRDominosP2.wav,201203221154580.PistaIVRDominosP 3.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

March 20, 2013

<index>

101

Response Codes & Messages Code 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

Description Invalid Operation.

Success.

Server Error.

Parameter Expected.

Login Failed.

Type Mismatch.

Connection is non-secure.

IP Check Failed.

Operation Unsuccessful.

Account could not be found.

Credit Limit Reached.

Invalid Account Status.

Invalid Activation/DeActivation Request.

ANI is already registered.

PIN is being used by another ANI. ANI could not be found.

Access Number could not be found.

Access Number/Account do not support this feature.

PIN is already registered.

Control Number is already registered.

There is no registered ANI under the account.

New PIN is not good.

Account already has this feature.

Insufficient Inventory.

Duplicate Attempt.

(Duplicate request attempts are disregarded for some of the transaction types if they occur within the same minute) Transaction Type is Blocked.

Product identifier could not be validated.

ANI is already registered under a different client.

SMS Campaign Not Found Cannot Cancel Campaign SMS Date Format Invalid.

Validation failed for field (account_password).

LEAD Disabled.

Number is Fixed No routing found for this type of network No senders found for this route Message length is greater to 160 characters

102

IPCOM NETWORKS © 2010

Account Statuses Code 1 0 3 101 222

Description Account is active.

Account is inactive.

Account has expired.

Account has been deactivated.

Account is destroyed.

Call Statuses Code 1 12 13 101 212 213 222 223 300 301 302 255

Description Successfully Processed.

Invalid Phone Number.

Insufficient Account Balance.

Being Processed.

Invalid Origination Phone Number.

Insufficient Account Balance.

Invalid Destination Phone Number.

Insufficient Account Balance.

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

CallBack time expired, unable to make call.

Account not WebCall-Enabled, contact customer support.

Not processed yet.

March 20, 2013

103