Delacon Provisioning API

Introduction

Delacon’s Provisioning API enables partners to manage the provisioning of new numbers through the use of a partner developed program rather than placing orders through the Delacon portal or Orders team. This approach is most suitable when ordering numbers frequently or in bulk, or to streamline the process of setting up or updating numbers. For example, your CRM system could be adapted to place an order for your end customer with the click of a button.

The Delacon Provisioning API key is generated within the Delacon portal after logging in with a valid user name and password. and is secured during API use by SSL authentication.

Integrating the API into your own system will require customer side development in line with the API specifications and parameters below, as such this documentation is suitable for a developer with relevant knowledge and experience.

 Setup and configuration

Please click here for the instructions on obtaining your API key.

API Specification

Create Customer

Request Type – POST

Request url - https://pla.delaconcorp.com/rest/config/provision

POST Request Header:-

a) Auth=<value of AuthToken>

POST parameters:-

a) BusinessName=<value>
b) BusCat=<value>
c) EmailAddress=<value>
d) TerminationNumber=<value>
e) BusID=<value>
f) features=CallFeedbackSurvey or CallRecording or CallFeedbackSurvey,CallRecording
g) region=Australia or China or Hong Kong or Japan or New Zealand or Singapore or United Kingdom or United States
h) numberType=<Depends on the value of the region supplied>. For ex, for ‘Japan’, following is the full list of allowed numberTypes:-

a. 0120 -> (0120 Japan Toll Free Number)
b. 03 -> (03 Tokyo)

Please see “Get Region Number Types” section below for additional number types

i) companyID=<value> (If this field is provided then all the fields above will be disregarded)
j) numbers=<value> (between 1 and 10)
k) orderSummaryEmail=<value>
l) termsCheck=on or off

Response Type – JSON

Response example:-

a) {“RESULT” : ”OK” , ”OrderId” : ”53” , “CID” : “999” , “Numbers” : “1234, 3456, 5678”}

In the JSON example above:-

“999” is the new companyid created (if a new customer created) OR the existing companyid
as specified in the request. “1234, 3456, 5678” is the list of new numbers provisioned.

OR

b) {“RESULT” : ”FAIL” , ”OrderId” : ”53” , ”MESSAGE” : ”Your order for new/additional numbers
could not be processed. Our support will look to serve your order.”}

OR

c) {“RESULT” : ”WAIT” , ”OrderId” : ”53” , ”MESSAGE” : ” Your order for new/additional numbers
is received. We will send you an email with order summary shortly.”}

OR

d) {“RESULT” : ”INVALID” , ”MESSAGE” : ”Data validation failed - ”}

OR

e) {“RESULT” : ”LOGIN_FAILED” , ”MESSAGE” : ”something went wrong”}

Update Customer

Request Type – POST

Request url - https://pla.delaconcorp.com/rest/config/updatecustomer/{companyID}

POST Request Header:-

a) Auth=<value of AuthToken>

POST parameters:-

m) BusinessName=<value>
n) BusCat=<value>
o) EmailAddress=<value>
p) OneThreeHundredNumber=<value>
q) TerminationNumber=<value>
r) BusID=<value>
s) whisper=Y or N
t) DNIS=Y or N
u) xfertype=1 or 2 or 3

a. 1 -> (Email Only)
b. 2 -> (Transfer Only)
c. 3 -> (Transfer and Email)

v) voicemal=Y or N
w) xfertime=<value> (maximum a 3-digit number)
x) moh=Y or N
y) SMSmessage=<value> (maximum 160 characters)
z) CallTrack=GooglePaid or AllPaidOnly or All or Selected or AllUtmMediumCpc

a. GooglePaid -> (Track just Google Paid)
b. AllPaidOnly -> (Track Google Paid, Yahoo Paid, Bing Paid)
c. All -> (Track All references)
d. Selected -> (Track Google / Yahoo / Bing & All Organic)
e. AllUtmMediumCpc -> (Track CPC Campaign Medium)

Following parameters have to be sent in an individual request with only one of the parameter specified. If combined with the parameters above, the return response will be {“RESULT” :”INVALID” , ”MESSAGE” : ”Data validation failed – invalid parameters for update”}

• CallRecording=Y or N
• CallFeedbackSurevy=Y or N
• IVR=Y or N

Response Type – JSON

Response example:-

a) {“RESULT” : ”OK” , “MESSAGE” : “this message is important for parameters which effect
billing” }

For the parameters (CallRecording, CallFeedbackSurvey and IVR), if switching from Y to N, for example, if CallRecording is provisioned for the customer, but the request suggests “CallRecording=N”, then the response will contain “MESSAGE” : “CallRecording disabled for customer, CallRecording Provisioned:Yes”

OR

b) {“RESULT” : ”FAIL” , ”MESSAGE” : ”something went wrong”}

For example, if CallRecording is not provisioned for the customer, but the request suggests “CallRecording=Y”, then the response will contain “MESSAGE” : “CallRecording Provisioned:No”

OR

c) {“RESULT” : ”INVALID” , ”MESSAGE” : ”Data validation failed - ”}

OR

d) {“RESULT” : ”LOGIN_FAILED” , ”MESSAGE” : ”something went wrong”}

Post Provisioning Response

Request Type – POST

Request url -

http://dealers.somewebsite.com/shared/callstats/somewebsitecallstats.delacon_1_0.asmx?op=UpdateOrderSta
tus

POST parameters:-

a) OrderID=<value>
b) Result=OK or FAIL
c) Message=<value>

Response Type – JSON

Response example:-

a) {“RESULT” : “ACCEPTED”}

OR

b) {“RESULT” : “FAIL” , ”MESSAGE” : ”something went wrong”}

Delacon system will try for 3 times until the “ACCEPTED” result is found.

Get Region Number Types

Request Type – POST

Request url - https://pla.delaconcorp.com/rest/config/getnumbertypes/{location}

POST Request Header:-

b) Auth=<value of AuthToken>

Response Type – JSON

Response example:-

a) {"Region":"ja-jp","NumberTypes":[{"desc":"0120 Japan Toll Free Number","key":"0120"},{"desc":"03 Tokyo","key":"03"}]}

OR

b) {“RESULT” : ”FAIL” , ”MESSAGE” : ”something went wrong”}

OR

c) {“RESULT” : ”LOGIN_FAILED” , ”MESSAGE” : ”something went wrong”}