Jabber API commands

The following documentation is officially supported by DreamHost. However, if you find any instructions in this article do not function as intended, it's possible it may be out of date. When in doubt, please contact support for further assistance.

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

Commands

jabber-list_users

Lists all Jabber users on this account and includes the user passwords and status. The status is one of the following: active, inactive, pending-active, pending-inactive, pending-delete

Command jabber-list_users
Values

(none)

Result

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

Possible errors

(none)

jabber-list_users_no_pw

Same as jabber-list_users, but leaves out the passwords. Passwords display as ********.

Command jabber-list_users_no_pw
Values

(none)

Result

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

Possible errors

(none)

jabber-list_valid_domains

Lists domains on your account that can have Jabber users.

Command jabber-list_valid_domains
Values

(none)

Result

success
domain
example.com
sub.example.com

Possible errors

(none)

jabber-add_user

Creates a new Jabber user. This returns 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 are applied together.

Command jabber-add_user
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 returns 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 are applied together.

Command jabber-remove_user
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 returns 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 are applied together.

Command jabber-reactivate_user
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 returns 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 are applied together.

Command jabber-deactivate_user
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

See also