API Methods

3jam.conversations.startTrial

Start a 3jam conversation with new users.

Authentication

No authentication is required, but requests must be verfied using Captcha and confirmation of an SMS code sent to the requesting user's mobile phone.

Arguments

api_key (required)
api_version (required)
message (required)
Message to send. Messages must be less than 100 characters.
friend_name[1] (required)
3jam user id for 1st friend to send 3jam to
friend_name[2] (optional)
3jam user id for 2nd friend to send 3jam to
friend_name[3] (optional)
3jam user id for 3rd friend to send 3jam to
friend_name[4] (optional)
3jam user id for 4th friend to send 3jam to
friend_name[5] (optional)
3jam user id for 5th friend to send 3jam to
friend_mobile[1] (required)
mobile number for 1st friend to send 3jam to
friend_mobile[2] (optional)
mobile number for 2nd friend to send 3jam to
friend_mobile[3] (optional)
mobile number for 3rd friend to send 3jam to
friend_mobile[4] (optional)
mobile number for 4th friend to send 3jam to
friend_mobile[5] (optional)
mobile number for 5th friend to send 3jam to

Response

On success, startTrial returns a conversation ID number. This number should be appended to http://api.3jam.com/captcha?id= to retrieve the Captcha graphic. The letters in the Captcha graphic must then be submitted to confirmCaptcha along with the conversation ID number to continue.

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <conversation id="97" />
</rsp>

Error Codes

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.
120: Message is a required argument
No message was specified in the request
121: Message must be less than 100 characters
The message sent was longer than 100 characters
135: F1_name is a required argument.
No friend names were found to send the message to.
136: F1_mobile is a required argument.
No friend mobile numbers were found to send the message to.
137: Invalid friend name "xxx"
The friend name specified is not valid
138: Invalid mobile number "xxx"
The mobile number specified is not valid
139: At least one friend required
At least one friend is required to start a 3jam
140: Maximum friends reached
Exceeded the maximum number of friends to 3jam with
141: Invalid name "xxx"
Invalid name. For user, one character for first name and one character for last name is the minimum required. Make sure there is a space between first and last name. For friends, first name is required.
142: Invalid mobile number "xxx"
Invalid mobile number. Non-U.S. numbers must be prepended with a '+' and country code.
145: Insufficent credits
The initiator of the conversation has insufficent credits. Please ask user to top up at http://www.3jam.com.