API/Jabber commands

From DreamHost
Jump to: navigation, search

Jabber commands

The jabber API module allows you to manage jabber users for your domains.

Commands

jabber-list_users

Lists all jabber users on this account (includes the users passwords and status). The status will be one of the following: active, inactive, pending-active, pending-inactive, pending-delete

Values:

(none)

Result:

success
username	domain	password	status
testuser	mywebsite.com	abc123	active
testuser2	mywebsite.com	12345	active

Possible Errors:

(none)

jabber-list_users_no_pw

Same as jabber-list_users but leaves out the passwords (passwords will display as ********).

Values:

(none)

Result:

success
username	domain	password	status
testuser	mywebsite.com	********	active
testuser2	mywebsite.com	********	active

Possible Errors:

(none)

jabber-list_valid_domains

Lists domains on your account that can have jabber users.

Values:

(none)

Result:

success
domain
mydomain.com
myseconddomain.com

Possible Errors:

(none)

jabber-add_user

Creates a new jabber user. This will return a service token (see Service Control Commands). This may return the same service queue token as previous calls to the jabber API. If this is the case, then all pending changes will be applied together.

Values:

username : the desired jabber username
domain : the domain for the new user
password : the password for the new user

Result:

success
token
gcnaBcD12eFgH34iJkL

Possible Errors:

no_username
no_domain
no_password
invalid_username
invalid_domain
invalid_password
user_exists

jabber-remove_user

Removes a jabber user. This will return a service token (see Service Control Commands). This may return the same service queue token as previous calls to the jabber API. If this is the case, then all pending changes will be applied together.

Values:

username
domain

Result:

success
token
gcnaBcD12eFgH34iJkL

Possible Errors:

no_username
no_domain
invalid_domain
user_does_not_exist
change_already_pending

jabber-reactivate_user

Reactivates a jabber user that had been disabled. This will return a service token (see Service Control Commands). This may return the same service queue token as previous calls to the jabber API. If this is the case, then all pending changes will be applied together.

Values:

username
domain

Result:

success
token
gcnaBcD12eFgH34iJkL

Possible Errors:

no_username
no_domain
invalid_domain
user_does_not_exist
user_already_active
change_already_pending

jabber-deactivate_user

Deactivates a jabber user. This will return a service token (see Service Control Commands). This may return the same service queue token as previous calls to the jabber API. If this is the case, then all pending changes will be applied together.

Values:

username
domain

Result:

success
token
gcnaBcD12eFgH34iJkL

Possible Errors:

no_username
no_domain
invalid_domain
user_does_not_exist
user_already_inactive
change_already_pending