3jam.friends.getList

Get a list of a 3jam user's friends and 3jam IDs. getList is used with startNew to start 3jam conversations.

Authentication

Authentication with a 3jam user's mobile phone number and password is required

Arguments

api_key (required)

api_version (required)

mobile (required)

Mobile number of 3jam user you're requesting friends for

password (required)

md5 the concatenation of the mobile number and 3jam password for this user. e.g. in PHP: md5($mobile . $password)

Response

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <friends user_id="25678" total="3">
    <friend id="355829365" name="Andy Jagoe" />
    <friend id="926538" name="Enlai Chu" />
    <friend id="203567" name="Thad White" />
  </friends>
</rsp>

Error Codes

98: Login failed

The login details or auth token passed were invalid.

100: Invalid API Key

The API key passed was not valid or has expired.

105: Service currently unavailable

The requested service is temporarily unavailable.

111: Format 'xxx' not found

The requested response format was not found.

112: Method 'xxx' not found

The requested method was not found.