API Method: POST user

Invites a new user to the room.

URL:

https://jaconda.im/api/rooms/#{room_id}/users.#{format}

Formats:

xml, json

HTTP Method(s):

POST

Parameters:

Note that all parameters are encapsulated within a user array (see example)

  • jid Required. The Jabber ID of the user you are inviting (What is it?).
  • name Optional. The name of the user you are inviting. This will be displayed in the chat.

Usage examples:

cURL:

$ curl -u api_token:x -d "user[jid]=client@gmail.com" https://jaconda.im/api/rooms/1/users.xml

Response:

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<user>
  <created-at type="datetime">2010-02-23T06:54:54Z</created-at>
  <id type="integer">5134</id>
  <is-paused type="boolean">false</is-paused>
  <jid>client@gmail.com</jid>
  <name>client</name>
  <paused-till type="datetime" nil="true"></paused-till>
  <room-id type="integer">1</room-id>
  <status nil="true"></status>
  <updated-at type="datetime">2010-02-23T06:54:54Z</updated-at>
</user>