Click 2 Dial

Updated 1 year ago by RM

Protocol:

HTTP 1.1

Url:

https://api.telecomstats.co.uk/IVRAPI/Scripts/ClickDialler.aspx

Port:

80

Method:

GET or POST

Required Parameters

Name

Type

Description

ClientID

Integer

Your 4 digit client ID.

Username

String

username

Password

String

password

aNumber

String

1st number to dial.

bNumber

String

2nd number to dial.

CLI

String

CLI to present to the first number dialled.

Optional Parameters

Name

Type

Values

CallReference

String

Customer Reference

aDTMF

String

First call dtmf digits

bDTMF

String

Second call dtmf digits

aHandShake

String

dtmf handshake

bHandShake

String

dtmf handshake

Error Returns

Errors will be returned with the status code HTTP 500:

Response

Explanation

Missing parameter '[param]'

A parameter was not supplied or was supplied empty.

Authentication failed.

An invalid combination of username, password or clientid was supplied.

OK Returns

OK responses will be returned with the status code HTTP 200 and in the following format of:

Response

Explanation

XX, OK

This request has been created. XX = Unique CallID

DTMF Handshake

When dialling some destinations it may be required to have the destination number to send back a signal so that the call can be answered, this can be done in the form of a DTMF handshake.

For Example:

Call is received on destination A, Destination A sends back a required dtmf, and our IVR sends the same one back, if all matches the details passed to the API then the usual call flow carries on.

The DTMF hanshake can be done on both parts of the call back process.

DTMF Digits

Please find below details of the valid inputs which can be entered into the dtmf handshake field, please note that this can be a string of digits:

DTMF Tone

API Code

0

0

1

1

2

2

3

3

4

4

5

5

6

6

7

7

8

8

9

9

A

A

B

B

C

C

D

D

* (Star)

E

# (Hash)

F

200ms Pause

,

1000ms Pause

-


How did we do?