API docs by Redocly

Vitelity Legacy API (1.0)

Download OpenAPI specification:

Reference for the legacy Vitelity command API, generated from the apihelp command database (apihelp.vitelity.net).

Every command is an HTTP request (GET or POST; parameters may be sent in the query string or form body) to a .php endpoint with a cmd parameter selecting the command, plus login and pass for authentication. Replies are plain text by default; send xml=yes for XML.

Plain-text replies are shown wrapped in x[[ ... [[x exactly as in the original help page; [[x / x[[ mark field boundaries.

This document describes 125 commands. Commands marked deprecated have moved to the 2.0 API.

Add-Ons

orderresidentiallisting

Order residential directory listing service for DID(s)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID or comma-separated list of DIDs

Example / format: Int

firstname
required
string

The first name to be displayed on the directory listing

Example / format: Listing first name

lastname
required
string

The last name to be displayed on the directory listing

Example / format: Listing last name

streetnumber
required
string

The street number of the residence

Example / format: Listing street number

streetname
required
string

The street name of the residence

Example / format: Listing street name

city
required
string

The city of the residence

Example / format: Listing city

state
required
string

The 2-character state abbreviation of the residence

Example / format: Listing state

zip
required
string

The 5-digit zipcode of the residence

Example / format: Listing zipcode

email
required
string

The email address of the listing owner, for verification if needed

Example / format: Email address

contact_phone
required
string

The phone number of the listing owner, for verification if needed

Example / format: Int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x invalid did(s) 7205551234,7205554321[[x

orderbusinesslisting

Order business directory listing service for DID(s)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID or comma-separated list of DIDs

Example / format: Int

businessname
required
string

The business name to be displayed on the listing

Example / format: Listing business name

streetnumber
required
string

The street number of the business

Example / format: Listing street number

streetname
required
string

The street name of the business

Example / format: Listing street name

city
required
string

The city of the business

Example / format: Listing city

state
required
string

The 2-character state abbreviation of the business

Example / format: Listing state

zip
required
string

The 5-digit zipcode of the business

Example / format: Listing zipcode

email
required
string

The email address of the listing owner, for verification if needed

Example / format: Email address

contact_phone
required
string

The phone number of the listing owner, for verification if needed

Example / format: Int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x invalid did(s) 7205551234,7205554321[[x

updateresidentiallisting

Update residential directory listing service for DID(s)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID or comma-separated list of DIDs

Example / format: Int

firstname
required
string

The first name to be displayed on the directory listing

Example / format: Listing first name

lastname
required
string

The last name to be displayed on the directory listing

Example / format: Listing last name

streetnumber
required
string

The street number of the residence

Example / format: Listing street number

streetname
required
string

The street name of the residence

Example / format: Listing street name

city
required
string

The city of the residence

Example / format: Listing city

state
required
string

The 2-character state abbreviation of the residence

Example / format: Listing state

zip
required
string

The 5-digit zipcode of the residence

Example / format: Listing zipcode

email
required
string

The email address of the listing owner, for verification if needed

Example / format: Email address

contact_phone
required
string

The phone number of the listing owner, for verification if needed

Example / format: Int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x invalid did(s) 7205551234,7205554321[[x

updatebusinesslisting

Update business directory listing service for DID(s)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID or comma-separated list of DIDs

Example / format: Int

businessname
required
string

The business name to be displayed on the listing

Example / format: Listing business name

streetnumber
required
string

The street number of the business

Example / format: Listing street number

streetname
required
string

The street name of the business

Example / format: Listing street name

city
required
string

The city of the business

Example / format: Listing city

state
required
string

The 2-character state abbreviation of the business

Example / format: Listing state

zip
required
string

The 5-digit zipcode of the business

Example / format: Listing zipcode

email
required
string

The email address of the listing owner, for verification if needed

Example / format: Email address

contact_phone
required
string

The phone number of the listing owner, for verification if needed

Example / format: Int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x invalid did(s) 7205551234,7205554321[[x

cancellisting

Cancel a directory listing

Authorizations:
(loginpass)
query Parameters
did
required
string

DID or comma-separated list of DIDs

Example / format: Int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x invalid did(s) 7205551234,7205554321[[x

Billing

balance

reports back your current account balance

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[500[[x

didcdrdetail

Give the seconds of use and cost for a specific did for a timeframe

Authorizations:
(loginpass)
query Parameters
startdate
required
string

Date to send in standard format

Example / format: 01-01-2012

enddate
required
string

Ending CDR date to send in standard format

Example / format: 01-02-2012

did
required
string

DID Number to receive records for

Example / format: int

type
string

Specify calls with this DID as callerid/source instead (type=outbound)

Example / format: outbound

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[seconds:cost[[x

subaccountcdrdetail

Pull details records for a specific sub account for a date range

Authorizations:
(loginpass)
query Parameters
startdate
required
string

CDR Startdate for the inquiry

Example / format: 01-01-2012

enddate
required
string

Ending CDR date to send in standard format

Example / format: 01-02-2012

subaccount
required
string

Specify the sub account for the inquiry

Example / format: subaccount

type
string

Accepted values:

  • outbound: Show only outgoing call records for this sub accounnt
  • inbound: Show only incoming call records for this sub account
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[seconds:cost[[x

getcdr

Get CDR Records for specified timeframe.

Authorizations:
(loginpass)
query Parameters
startdate
required
string

Startdate

Example / format: 01-01-2014

enddate
required
string

Enddate

Example / format: 02-01-2014

subaccount
string

Return records for specific sub account

Example / format: sub account or IP

addsub
string

Adds sub account/peer info to records. Send &addsub=yes

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[Calldate,SRC,DST,Duration,Clid,Disposition,Cost[[x

downloadsmssc

Download SMS Short Code Records

Authorizations:
(loginpass)
query Parameters
startdate
string

Specify Start Date for records

Example / format: 01-01-2014

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[\"date\",\"incoming or outgoing\",\"source\",\"destination\",\"message delivered\",\"shortcode\",\"number of msgs counted\"
[[x

didminutes

DID minutes

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

DID Inventory

listtollfree Deprecated

This API route has been deprecated. Use POST /2.0/did/tollfree/search instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listlocal Deprecated

This API route has been deprecated. Use POST /2.0/did/local/search instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listnpanxx Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listratecenters Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listavailratecenters Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

searchtoll Deprecated

This API route has been deprecated. Use POST /2.0/did/tollfree/search instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listavailstates Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

liststates Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listdids

lists all current Local and Toll free DIDs

Authorizations:
(loginpass)
query Parameters
extra
string

Display state and rate per min on text output only

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[2015551212,JERSEYCITY,.015,Main
2015551213,JERSEYCITY,.015,Main
{NUMBER},{RATECENTER},{RATE_PER_MINUTE},{SUB_ACCOUNT}
[[x

<u>With extra=yes POSTed</u>

x[[2015551212,JERSEYCITY,.015,Main,NJ,1
2015551213,JERSEYCITY,.015,Main,NJ,1
{NUMBER},{RATECENTER},{RATE_PER_MINUTE},{SUB_ACCOUNT},{STATE},{RATE_PER_MONTH}
[[x

didnote

Add note to DID for future reference

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to set note on

Example / format: int

note
required
string

The note to set your DID to (leave blank to delete)

Example / format: A-z note to add

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x

listintlratecenters Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listintl Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

getdidnote

Get the current DID note set for a specific DID

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to return note for

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[(note set for did number)[[x

listspecificlocal

Lists the rates assocated with a specific and Available DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to verify rates on

Example / format: int

withrates
string

Display the rates you will pay for the specific number

Example / format: yes

onaccount
string

Display information about a number on your account

Example / format: yes

addstate
string

Add the state to the DID rate center information

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[[NUMBER],[RATECENTER],X[[x

listnpa Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

lidb

Set the CallerID Name for a specific number (LIDB / CNAM)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to change LIDB on

Example / format: int

name
required
string

Callerid Name to set - 15 Character Max

Example / format: int or letters

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

lidbavailall

List all numbers where LIDB / CallerID / CNAM name change is available

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[3035551212
3035551213
3035551214
[[x

getdidrate

Get rate information for specific DID currently owned by you

Authorizations:
(loginpass)
query Parameters
number
required
string

10 digit DID number

Example / format: XXXXXXXXXX

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[x[[XXXXXXXXXX:PPM_COST:MRC[[x[[x

listvmdids

List DIDs associated with a specific voicemail box

Authorizations:
(loginpass)
query Parameters
vmbox
required
string

Voicemail box number

Example / format: Voicemail Box Number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[XXXXXXXXXX
XXXXXXXXXX
XXXXXXXXXX
[[x

setvmemail

Set voicemail account email address

Authorizations:
(loginpass)
query Parameters
vmbox
required
string

Voicemail box number

Example / format: Voicemail Box Number

email
required
string

Email Address

Example / format: Email Address

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[success[[x

getdidnotes

Get notes for all DIDs

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[XXXXXXXXXX:My Office
XXXXXXXXXX:My Home[[x

DID Ordering

getbackorder Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

gettollfree Deprecated

This API route has been deprecated. Use POST /2.0/did/tollfree/order instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

getlocaldid Deprecated

This API route has been deprecated. Use POST /2.0/did/local/order instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

removedid

Remove a currently assigned DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID number to remove

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[success[[x

requestvanity Deprecated

This API route has been deprecated. Use POST /2.0/did/tollfree/search/vanity instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

localbackorder

back orders a specific ratecenter/state that is not in stock

Authorizations:
(loginpass)
query Parameters
ratecenter
required
string

The requested ratecenter

Example / format: ratecenter

state
required
string

The requested state

Example / format: Two letter state

returnid
string

Returns a backorder id for future tracking

Example / format: yes

type
string

Order the DID number as perminute, unlimited or assigned to a vPRI

Example / format: perminute unlimited {pri_name}

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

<u>Result with returnid=yes will be the orderid</u>

x[[732838[[x

getintldid Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

localbackorderrate Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

didforcebilling

Force the billing for a specific DID to a certain sub account

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to change billing to

Example / format: int

subacc
required
string

The sub account or IP address to bill to or NONE

Example / format: subaccount or none

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

listnpas Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

reservedid Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

releasedid Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

E911

e911send

Input or update new 911 address for a specific DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to change 911 information on

Example / format: int

name
required
string

Name of the person or business registering for 911

Example / format: customer_name

address
required
string

Address of the registered 911 customer

Example / format: customer_address

city
required
string

City of the registered 911 customer

Example / format: customer_city

state
required
string

State of registered 911 customer

Example / format: customer_state

zip
required
string

Zip code of registered 911 customer

Example / format: int

unittype
string

Type of unit customer lives in

Example / format: unit or suite or apt

unitnumber
string

Unit number or letter of customer premise

Example / format: number or letter(s)

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[name=MR MOO
number=3035551212
address=123 SECOND ST
city=GREENWOOD VILLAGE
state=CO
zip=80111
[[x

e911delete

Delete a registered 911 address from a specific DID

Authorizations:
(loginpass)
query Parameters
did
required
string

Specific DID Number to delete

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

e911checkaddress

Check eligibility of a specific address for 911 service

Authorizations:
(loginpass)
query Parameters
address
required
string

Address of the registered 911 customer

Example / format: customer address

city
required
string

City of the registered 911 customer

Example / format: customer city

state
required
string

State of registered 911 customer

Example / format: customer state

zip
required
string

Zip code of registered 911 customer

Example / format: customer zipcode

did
required
string

DID Number to enable 911 on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[name=MR MOO
number=3035551212
address=123 SECOND ST
city=GREENWOOD VILLAGE
state=CO
zip=80111
[[x

e911getinfo

Get 911 information on a specific DID Number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to verify information on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[name=MR MOO
number=3035551212
address=123 SECOND ST
city=GREENWOOD VILLAGE
state=CO
zip=80111
[[x

e911notifyadd

Set destination for E911 notifications

Authorizations:
(loginpass)
query Parameters
did
required
string

10 digit did you want e911 notifications from

Example / format: int

method
required
string

Method of notification

Example / format: either "text" or "email"

item
required
string

Notification value: Email address if method is "email", 10 digit did if method is "text"

Example / format: email or int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

e911notifydelete

e911notifydelete (no description in legacy data)

Authorizations:
(loginpass)
query Parameters
did
required
string

Specific DID Number

Example / format: int

method
required
string

Method of notification to remove

Example / format: "text", "email" or "all"

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

Fax

listincomingfaxes

Lists all incoming faxes

Authorizations:
(loginpass)
query Parameters
faxid
string

Specific faxid number to capture

Example / format: int

type
string

Specific if you want just unread messages

Example / format: unread

xmlcomply
string

XML Compliant - if using XML, highly suggest (bugfix)

Example / format: yes

showpages
string

Show page count for faxes

Example / format: yes

vfaxacc
string

Show faxes for a specific vFax account only

Example / format: vfax_account_login

start
string

Date range start for faxes; date only or date and time

Example / format: yyyy-mm-dd hh:mm:ss

end
string

Date range end for faxes; date only or date and time

Example / format: yyyy-mm-dd hh:mm:ss

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[113812,2007-03-09 19:44:45,3035551212,3039991212,deleted
113803,2007-03-09 18:48:22,3035551212,3039991212,read
155854,2007-05-17 23:37:01,3035551212,3039991212,new
[[x

getfax

Retrieve a specific fax from our system

Authorizations:
(loginpass)
query Parameters
faxid
required
string

Specific faxid number to capture

Example / format: int

type
string

Download file as base64encoded instead of web download request

Example / format: base64

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[
We will send a content-type and disposition for a download request.

Standard RFC compliant web download

This is not applicable.
[[x

sentfaxstatus

Lists all or specific info on sent faxes

Authorizations:
(loginpass)
query Parameters
showxmlstatus
string

Show the status in XML requests (bug fix)

Example / format: yes

did
string

Faxes sent from specific DID number

Example / format: int

showall
string

Show entire sent fax history

Example / format: yes

faxid
string

Specific sent fax id to lookup info on. Supports multiple separated by a comma

Example / format: int

showpages
string

Show page count for faxes

Example / format: yes

vfaxaccount
string

Show sent faxes for a specific vFax account

Example / format: vFax Account Login

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[1824488,2007-05-25 03:43:25,Success,3035551212,3033331212
1824490,2007-05-25 03:55:07,Success,3035551213,3033331213
[[x

sendfax

Allows you to send a fax over the API

Authorizations:
(loginpass)
query Parameters
faxnum
required
string

The outbound fax number to send to

Example / format: int

faxsrc
required
string

The vfax DID to send fax from

Example / format: int

recname
required
string

The receivers name you're sending to

Example / format: letters

file1
required
string

The name of the first file

Example / format: filename.extension

data1
required
string

Base64 encoded data of the file you're sending

Example / format: base64encode

file2
string

The name of the second file you're sending

Example / format: filename.extension

data2
string

Base64 encoded data of the file you're sending

Example / format: base64encode

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok:jobid[[x

faxlistdids Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

faxgetdid Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

faxlistratecenters Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

faxliststates

Lists all of the available states line by line

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[AL
AR
CA
CO
[[x

faxchangeemail

Changes email addresses assigned to a vFax DID (new faxes are emailed here)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to change where emails are sent

Example / format: int

emails
required
string

Email addresses separated by commas

Example / format: email@email.com,em@e.com

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

newfaxacc

Creates new vFax account for use with viewmyfax.com/faxcentral.net

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

New vfax login to create

Example / format: number or letter(s)

accpass
required
string

New vfax password for login

Example / format: number or letter(s)

accname
required
string

The persons name or company name

Example / format: number or letter(s)

did
required
string

DID Numbers associated with account separated by commas

Example / format: number,number

accemails
string

Add emails for access to emailyourfax.com fax-to-email sending

Example / format: email@email.com,em@e.com

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

setfaxacc

Set DIDs or emails associated to vFax account

Authorizations:
(loginpass)
query Parameters
faxacc
required
string

The specific vfax login

Example / format: vfaxlogin

did
string

DID Numbers separated by commas

Example / format: did,did

accemails
string

Email addresses separated by commas. Set to 'none' to remove all emails from account

Example / format: email,email or none

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

allowdidchangeemail

This option allows end user to modify the email addresses faxes are sent to when they receive a fax

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

The specific vfax login

Example / format: vfaxlogin

set
required
string

Set whether they can change or not

Example / format: yes or no

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

allowoutchangeemail

Allows user to update the email addresses for sending out faxes to number@emailyourfax.com.

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

The specific vfax login

Example / format: vfaxlogin

set
required
string

Set whether they can change or not

Example / format: yes or no

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

increasecredits

Increases the number of DIDs a specific vFax account is allowed to order.

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

The specific vfax login

Example / format: vfaxlogin

amount
required
string

Increase number of DIDs/Credits for a vfax by x amount

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

setcredits

Set the number of DIDs a vfax account can order through viewmyfax portal

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

The specific vfax login

Example / format: vfaxlogin

amount
required
string

Number of DIDs/Credits a vfax can order

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

getcredits

Return how many DID order credits a customer has remaining on a vfax account

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

The specific vfax login you're looking for

Example / format: vfaxlogin

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[integer-number of credits[[x

setlimit

Set the number of daily outbound faxes a specific vFax account can send per day

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

The vFax login to modify

Example / format: fax login

limit
required
string

Number of faxes to allow

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

faxlistmydids

Return a full list of your vfax numbers

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[none[[x

delfaxacc

Remove existing vFax account

Authorizations:
(loginpass)
query Parameters
acclogin
required
string

vFax Account login

Example / format: login

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[ok[[x

getfaxenable

Order a Fax Enable device for a specific vFax DID

Authorizations:
(loginpass)
query Parameters
did
required
string

vFax DID for which to order the Fax Enable device

Example / format: 10 digit number

name
required
string

End user name

Example / format: End user name

address
required
string

Street number and street name of mailing address for end user

Example / format: Street Number and Name of End user address

address2
string

End user address Suite, Unit, Apt number

Example / format: Suite XXX, etc

city
required
string

City of End user address

Example / format: City name

state
required
string

State of End user address

Example / format: 2 Letter State Abbreviation

zip
required
string

Zip Code of End user address

Example / format: 5 digit Zip Code

phone
required
string

Contact phone for end user

Example / format: 10 digit number

email
required
string

Contact email address for end user

Example / format: email@email.com,em@e.com

subscription
string

Orders a FAX Enable device for a $35 setup fee plus $24.95 per month

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[missingdata[[x

cancelfaxenable

Remove the Fax Enable service from a specific DID

Authorizations:
(loginpass)
query Parameters
did
required
string

vFax DID losing the Fax Enable service

Example / format: 10 digit number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[missingdata[[x

delfax

Delete a fax from the vFax system

Authorizations:
(loginpass)
query Parameters
faxid
required
string

Fax ID number to delete

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x

getsentfax

Get sent fax file. Note: It can take up to an hour for the fax to be available.

Authorizations:
(loginpass)
query Parameters
faxid
required
string

Faxid number for sent fax

Example / format: XXXXXXXXXX

type
string

Download file as base64encoded instead of web download request

Example / format: base64

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[We will send a content-type and disposition for a download request.

Standard RFC compliant web download

This is not applicable.[[x

getfaxacc

Get name, DIDs, and emails associated to vFax account

Authorizations:
(loginpass)
query Parameters
faxacc
required
string

The specific vfax login

Example / format: vfaxlogin

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[Name
DID,DID,DID
Email,Email,Email[[x

faxpagecounts

Generates a page count report for faxes

Authorizations:
(loginpass)
query Parameters
startdate
string

Date range start for faxes; date only or date and time

Example / format: yyyy-mm-dd hh:mm:ss

enddate
string

Date range end for faxes; date only or date and time

Example / format: yyyy-mm-dd hh:mm:ss

vfaxacc
string

Show faxes for a specific vFax account only

Example / format: vfax_account_login

xmlcomply
string

XML Compliant - if using XML, highly suggest (bugfix)

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[113812,2007-03-09 19:44:45,Failed,3035551212,3039991212,none,2,Incoming
113803,2007-03-09 18:48:22,Success,3035551212,3039991212,george,1,Outgoing
155854,2007-05-17 23:37:01,Success,3035551212,3039991212,none,5,Incoming[[x

delsentfax

Delete a sent fax from the vFax system

Authorizations:
(loginpass)
query Parameters
faxid
required
string

ID of the sent Fax to delete

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x

undelsentfax

Undelete a previously deleted sent fax

Authorizations:
(loginpass)
query Parameters
faxid
required
string

ID of the sent Fax to undelete

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x

cleardidfaxes

Delete all the sent and received faxes associated with a fax DID

Authorizations:
(loginpass)
query Parameters
did
required
string

The fax DID whose history you want to clear

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x

undelfax

Undelete a fax from the vFax system

Authorizations:
(loginpass)
query Parameters
faxid
required
string

ID of the Fax to undelete

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[invalid[[x

faxlisttollfree Deprecated

This API route has been deprecated and has no direct replacement. See the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

LNP

addport Deprecated

This API route has been deprecated. Use POST /2.0/lnp/portInOrder instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

checkavail Deprecated

This API route has been deprecated. Use POST /2.0/lnp/checkPortability instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

checkmultiavail Deprecated

This API route has been deprecated. Use POST /2.0/lnp/checkPortability instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

checkstatus Deprecated

This API route has been deprecated. Use GET /2.0/lnp/orders/{orderId} instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

listports Deprecated

This API route has been deprecated. Use GET /2.0/lnp/orders instead; see the Vitelity API 2.0 documentation.

Authorizations:
(loginpass)

Responses

Placing Call

callfromclick

Sends someone a phone call that then connects them to customer service/another number. This service is strictly for US and Canadian destinations.

Authorizations:
(loginpass)
query Parameters
number
required
string

The persons number that will be receiving the call

Example / format: int

servicenumber
required
string

The number of the person you're connecting to

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

Routing & Network

reroute

changes the sub account or IP that the DID routes to

Authorizations:
(loginpass)
query Parameters
routesip
required
string

The sub account or IP address to route this DID to

Example / format: Sub account or IP

did
required
string

The specific DID you're changing routing on. Now supports "all" to update routing on ALL DIDs

Example / format: int

type
string

Accepted values:

  • ata: Set routing to Server or ATA/Softphone. Default is server. Send type=ata for use with ATA/Softphone.
  • tcp: Set routing to TCP Server. Default is server.
updatednis
string

Update the DNIS/extension for your DID(s)

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

routeall

Changes routing for ALL of your DID numbers to a specific IP or sub account

Authorizations:
(loginpass)
query Parameters
routesip
required
string

The sub account or IP address to route all DIDs to

Example / format: Sub account or IP

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

getrate

Gets a rate on a specific domestic or International call (ex:011-number or 1-number)

Authorizations:
(loginpass)
query Parameters
number
required
string

Number you wish to receive cost information on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[per_minute_rate[[x

subaccounts

Lists all sub accounts

Authorizations:
(loginpass)
query Parameters
do
string

Accepted values:

  • list: Command to list Sub Accounts
  • suspend: Command to suspend a sub account
  • restore: Command to restore a sub account
  • callerid: Command to update sub account Caller ID
subacc
required
string

Variable to pass to suspend/restore a specific sub account

Example / format: subaccount login

callerid
string

Variable to pass for updating Caller ID

Example / format: valid 10 digit number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[subaccount1
subaccount2
[[x

failover

Set fail over for a specific DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to set failover on

Example / format: int

failnum
required
string

Accepted values:

  • int: The number to dial when call routing fails
  • int: Set failnum to none to remove
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

callfw

Set call forwarding for specific DID

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to change callfw on

Example / format: int

forward
required
string

The destination number to forward to

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

newvoicemail

New voicemail account - Allows you to create a new voicemail account

Authorizations:
(loginpass)
query Parameters
mailbox
required
string

Mailbox number to create (2-10 digits)

Example / format: int

newpass
required
string

Four digit pin number for mailbox

Example / format: int

name
required
string

The name for this mailbox

Example / format: letters

email
required
string

Email address to send new voicemails to

Example / format: Email address

timezone
string

Change timezone - Default is MST

Example / format: CST/EST/MST/PST

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

resetvoicemail

Reset voicemail password for specific account

Authorizations:
(loginpass)
query Parameters
mailbox
required
string

Mailbox number to change

Example / format: int

newpass
required
string

New four digit pin for mailbox

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

listvoicemails

List all voicemail accounts

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[mailbox:password:fullname:email
[[x

addvoicemailtodid

Link a voicemail account to a did number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to link a voicemail account to

Example / format: int

rings
required
string

Number of rings until voicemail picks up

Example / format: int

vmbox
required
string

Voicemail box to link DID to (none to remove)

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

cnamenable

Enable CNAM Services on a specific DID

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to enable CNAM on

Example / format: int

type
string

Specify unlimited instead of per query

Example / format: unlimited

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

cnamdisable

Disable CNAM on a specific DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to disable CNAM on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

cnamstatus

Check whether CNAM is disabled or enabled on a specific DID Number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to verify CNAM status on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[enabled[[x

addsubacc

Add a sub account or SIP peer to your account

Authorizations:
(loginpass)
query Parameters
peer
required
string

Must be an a-z login with 4 to 10 characters OR an IP address

Example / format: a-z,0-9, 4-10 characters

secret
required
string

The password for the peer or subaccount

Example / format: a-z or 0-9 with 6 to 14 characters

callerid
string

Ten digit callerid value for this sub account

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

delsubacc

Delete a SIP Peer or Sub Account from your account (irreversible)

Authorizations:
(loginpass)
query Parameters
peer
required
string

SIP Peer or Sub Account you wish to erase

Example / format: peer_login

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

lidbavail

Verify availability of CallerID name on a specific DID (only works on limited DID numbers)

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to change CallerID on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[avail[[x

lidbcheck

Give status of a lidb request

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to verify CalleriD information on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[(current cnam)[[x

remvoicemail

Delete voicemail account

Authorizations:
(loginpass)
query Parameters
mailbox
required
string

Mailbox number

Example / format: Mailbox number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[x[[ok[[x[[x

migratedids

Migrate DID Numbers from one sub account to another

Authorizations:
(loginpass)
query Parameters
origsubaccount
required
string

The original sub account to migrate from

Example / format: subaccount

tosubaccount
required
string

The new sub account to transfer numbers to

Example / format: subaccount

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[1[[x

massreroute

changes the sub account or IP that multiple DIDs routes to

Authorizations:
(loginpass)
query Parameters
routesip
required
string

The sub account or IP address to route this DID to

Example / format: Sub account or IP

dids
required
string

DID numbers separated by a comma to update the routing on

Example / format: 10 digit DIDs separated by comma's

type
string

Set routing to Server or ATA/Softphone. Default is server. Send type=ata for use with ATA/Softphone.

Example / format: ata

updatednis
string

Update the DNIS/extension for your DID(s)

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

gettfrate

Get Inbound Toll Free Rate from API

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[tf_did_mrc:tf_did_pm_rate[[x

checkfailover

Check Failover status on DID

Authorizations:
(loginpass)
query Parameters
did
required
string

DID number

Example / format: 10 digit DID number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[yes:failover_number[[x

showroute

Show current peer specific DID is routing to

Authorizations:
(loginpass)
query Parameters
did
required
string

10 digit DID number

Example / format: 10 digit DID number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[peer_name or IP[[x

intlrates

International Termination Rates

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[AFGHANISTAN,93,0.XXXX
AFGHANISTAN MOBILE,9371,0.XXXX
AFGHANISTAN MOBILE,9373,0.XXXX
AFGHANISTAN MOBILE,9374,0.XXXX[[x

blocklist

Block numbers from calling your account or specific DID numbers on your account

Authorizations:
(loginpass)
query Parameters
type
string

Send type=remove to remove number from blocklist

Example / format: remove

cid
required
string

Caller ID number to block

Example / format: 10 digit DID number

did
string

DID to block calls on

Example / format: 10 digit DID number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[x[[ok[[x[[x

updatednis

Update DNIS for specific DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

10 digit DID number

Example / format: XXXXXXXXXX

dnis
required
string

DNIS prefix for DID number

Example / format: XXXXXXXXXX or none

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

subintl

Toggle International Access on Sub Accounts

Authorizations:
(loginpass)
query Parameters
sub
required
string

Sub Account or IP

Example / format: Sub Account or IP

action
required
string

Action, restore or suspend

Example / format: restore or suspend

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

SMS

checksms

Check availability of SMS on a specific DID

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to verify SMS availability on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

removesms

Remove SMS from a specific DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to remove SMS on

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

smsdids

List all DIDs that you OWN and have SMS functionality available

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[3035551212
3034441212
[[x

smsenableurl

Set the URL for SMS messages to be delivered to for SMS+http enabled DIDs

Authorizations:
(loginpass)
query Parameters
url
required
string

URL_Encoded URL for

Example / format: https://mySmsHttpServer.com/sendme.php

did
string

DID Number to enable HTTPD SMS on

Example / format: 9705551234

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[ok[[x

sendsms

Send an SMS message from an SMS enabled DID number

Authorizations:
(loginpass)
query Parameters
src
required
string

Source telephone number

Example / format: int

dst
required
string

Destination telephone number

Example / format: int

msg
required
string

The message to send to the destination

Example / format: a-Z,0-9,Basic Characters

allowall
string

This will allow any type of characters instead of just standard

Example / format: yes

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

listsmsurl

List SMS URLs for Posting messages

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[XXXXXXXXXX,http://www.blah.com/post.php,358b77fb-b171-46f6-8791-9a06d4fd75cc
0,http://www.blah.com/post.php,19225a86-f5da-47b4-bb45-8437e945de85
[[x

listsms

List DIDs with S.MS or HTTP enabled

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[XXXXXXXXXX,XXXXXXXXXX@s.ms,no
XXXXXXXXXX,http,yes[[x

smstoemail

Configure SMS to email for specific DID number

Authorizations:
(loginpass)
query Parameters
action
required
string

Action to enable or disable service

Example / format: enable/disable

email
string

Email address - Required for enable

Example / format: Email address

did
required
string

10 digit DID number

Example / format: 10 digit DID number

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[success[[x

smssettoken

Set http authorization token for outbound sms server

Authorizations:
(loginpass)
query Parameters
xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[91d1c005-6698-4a84-ad49-0cb87f0cf49a[[x

enablesms

Enable SMS on a specific DID number

Authorizations:
(loginpass)
query Parameters
did
required
string

DID Number to enable SMS on

Example / format: int

nnid
required
string

The NNID to activate P2P messaging on

Example / format: a-Z,0-9,Basic Characters

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[ok[[x

Telecom Functions

cnam

looks up the specific caller id name for a specific number

Authorizations:
(loginpass)
query Parameters
did
required
string

The number to lookup for caller id

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
x[[WIRELESS CALLER[[x

npanxxlookup

Lookup Ratecenter & State name in LERG format

Authorizations:
(loginpass)
query Parameters
npa
required
string

Area Code/NPA

Example / format: int

nxx
required
string

First 3 digits after area code (NXX)

Example / format: int

xml
string
Value: "yes"

Sending xml=yes will return your results as XML instead of plain text

Responses

Response Schema:
string

Response samples

Content type
Example
x[[RATECENTER:STATE[[x