Protocol for API tasks

Send Message

Send message to a single or multiple mobile numbers, @username or #groupcode

Parameters	Name or description
Operation	pv
Mandatory	u h to msg
Optional	type unicode from footer nofooter format
Returns	return codes

Parameter to can be international formatted mobile number, #groupcode or @username, or a mix of them. Separate by commas for multiple values. Numbers starting without country code will be replaced by default country code in your user preferences account.

Outgoing SMS and delivery status

List outgoing SMS and delivery status.

Parameters	Name or description
Operation	ds
Mandatory	u h
Optional	queue src dst dt smslog_id c last format
Returns	data or return codes

Parameter c will retrieve as many as c value, last retrieves data from last SMS log ID.

 

Inbox

List SMS on user's inbox.

Parameters	Name or description
Operation	ix
Mandatory	u h
Optional	queue src dst dt smslog_id c last format
Returns	data or return codes

Parameter c will retrieve as many as c value, last retrieves data from last SMS log ID.

User Credit

Get user's credit information.

Parameters	Name or description
Operation	cr
Mandatory	u h
Optional	format
Returns	user's credit or return codes

Get Token

Get user's webservices token. This can be used as a login mechanism.

Parameters	Name or description
Operation	get_token
Mandatory	u p
Optional	format
Returns	webservices token or return codes

Set Token

Set user's webservices token. This can be used as a change password mechanism.

Parameters	Name or description
Operation	set_token
Mandatory	u h
Optional	format
Returns	new webservices token or return codes

Get Contact List

Get contact list by name, mobile or email.

Parameters	Name or description
Operation	get_contact
Mandatory	u h kwd
Optional	c format
Returns	list of contacts similar or the same as kwd or return codes

Get Group Contact List

Get group contact list by name or code

Parameters	Name or description
Operation	get_contact_group
Mandatory	u h kwd
Optional	c format
Returns	list of contact groups similar or the same as kwd or return codes

Query

Query server for useful information such as user's data, user's credit, last smslog_id for inbox, incoming and outgoing SMS

Parameters	Name or description
Operation	query
Mandatory	u h
Optional	format
Returns	server's information