API Methods
3jam.conversations.startNew
Start a new 3jam conversation
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)
message(required)- Message to send. Messages must be less than 100 characters.
friend_id[1](required)- 3jam user id for 1st friend to send 3jam to
friend_id[2](optional)- 3jam user id for 2nd friend to send 3jam to
friend_id[3](optional)- 3jam user id for 3rd friend to send 3jam to
friend_id[4](optional)- 3jam user id for 4th friend to send 3jam to
friend_id[5](optional)- 3jam user id for 5th friend to send 3jam to
friend_id[6](optional)- 3jam user id for 6th friend to send 3jam to
friend_id[7](optional)- 3jam user id for 7th friend to send 3jam to
friend_id[8](optional)- 3jam user id for 8th friend to send 3jam to
friend_id[9](optional)- 3jam user id for 9th friend to send 3jam to
friend_id[10](optional)- 3jam user id for 10th friend to send 3jam to
friend_id[11](optional)- 3jam user id for 11th friend to send 3jam to
friend_id[12](optional)- 3jam user id for 12th friend to send 3jam to
friend_id[13](optional)- 3jam user id for 13th friend to send 3jam to
friend_id[14](optional)- 3jam user id for 14th friend to send 3jam to
friend_id[15](optional)- 3jam user id for 15th friend to send 3jam to
Response
Either success or failure with an error code. No XML payload.
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.
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.
130: At least one friend must be specified- No friends were found to send the message to.
131: Invalid friend ID 'xxx'- The requested ID number is not in the friend's list of this 3jam user.
140: Maximum friends exceeded- Exceeded maximum number of friends to 3jam with.
145: Insufficent credits- The initiator of the conversation has insufficent credits. Please ask user to top up at http://www.3jam.com.
