API Reference

Following the next steps you will be able to connect Phonify API and start sending SMS worldwide. If you already have an account with a billing method you will be able to start sending messages immediately.

The Phonify API is organised around Rest. We unify all behaviour into predictable, consistent results using recommended specifications like HTTP authentication, verbs and resources.

All verbs are performed as GET, POST, PUT (when updating) and DESTROY. All results are returned in jSON.

Authentication

All requests to Phonify API need to be authenticated using the API key provided to you.

You can find your current key visiting your Settings page.

There are two ways to authenticate easily. You can do it with a HTTP Basic Authentication header using your key as the username or you can also send it as api_key parameter in the request.

Arguments

api_key
string
Required
Authenticate easily sending your api key as an argument.

Errors

Phonify uses conventional HTTP response codes to indicate status of a request.

When a request is valid but does not complete as expected we return a 402 error and a errors JSON object is attached to the object including a collection of errors including type and title.

Errors Collection

Attributes

type
string
The type of error. This is a unique string to help identify precisely the error.
title
string
Indicates the error in readable plain english.

Messages

All sent and received messaging share the same message object.

Attributes

id
string
body
string
An arbitrary string that contains the content of the message. Up to 160 characters.
to
msisdn
MSISDN as defined in the E.164 international number format including the plus sign.
origin
list
Show child attributes
Hide child attributes
number
string
country
string
carrier
optional
phone
list
Show child attributes
Hide child attributes
number
string
country
string
carrier
optional
state
string
Alfanumeric string containing the current state of the message, default is unconfirmed. Valid options are unconfirmed, sent and error.
created_at
timestamp

Sending a message

Arguments

to
msisdn
Required
MSISDN as defined in the E.164 international number format including the plus sign.
body
string
Required
An arbitrary string that contains the content of the message. Up to 160 characters.

Returns

Returns a collection of the message objects in JSON format.

Retrieving a message

Arguments

id
string
Required
Identifier of message desired.

Returns

Returns a message object in JSON format.

List all messages

Arguments

offset
optional
default is 0
limit
optional
default is 50
Maximum 1000

Returns

Returns a collection of most recent messages objects matching the given criteria in JSON format.