Getasms SMS API
List SMS Address Books

Description

Get a listing of all SMS Address Books.

Method

Get

Call

Base URL
https://api.getasms.com/api/v1/address_book/list.xml
Name Mandatory Description
id_client
YES
This is a unique ID to identify the client
api_key
YES
This is a GUID to identify the client and to access the API
 NumberOfRecords 
NO
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page size (number of records per page)
PageNumber
NO
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
SortByName
NO
Default: false (and then sort by Creation Date Desc)

Result

								
<api version="1">
	<address_books>
		<address_book>
			<address_book_id>4254</address_book_id>
			<name>FirstSms</name>
			<total_number_phone>3</total_number_phone>
		</address_book>
		<address_book>
			<address_book_id>4314</address_book_id>
			<name>SecondList</name>
			<total_number_phone>2</total_number_phone>
		</address_book>
	</address_books>
</api>
								
								

Result Attributes

Name
Description
AddressBooks[] Contains list of address books
    AddressBook[] Identify each address book
        address_book_id ID of the address book
        name Name of address book
        total_number_phone Total of number phones in this address book
 

Send SMS around the world with GetaSMS™

Easy to use with the lowest costs on the market