Instant Messaging

Send IM

Send an instant message

URI: /comb/v1/d/imsg/send

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: instantMessage

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Invalid header specified
400	Invalid payload specified
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Start IM

Sets up the current session to support an Instant Messaging client. This informs the system that the client wishes to use Beehive's Instant Messaging service and wishes to receive Instant Messaging and Presence updates. The current user's presence is also updated with a new contact method representing the Instant Messaging client being started. The {name} specifies the resource name for this Instant Messaging client.

URI: /comb/v1/d/imsg/{name}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
reachability	Query	Restricted to: AWAY CHATTY DO_NOT_DISTURB EXTENDED_AWAY NOT_REACHABLE REACHABLE	This parameter specifies the initial reachability status of the instant messaging session. If unspecified, this defaults to REACHABLE.

Request Payload: No Request Payload

Response Payload: instantMessagingSession

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Invalid value specified for query parameter
400	Name already in use
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Stop IM

Stops the IM client with the specified name and updates the current user's presence

URI: /comb/v1/d/imsg/{name}

HTTP Method: DELETE

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred