Send signal to channel
This resource allows a developer to send a signal to a channel.
Returns a three-element array:
- Array element 0 - (Integer)
1or0, where1is a success, and0is an error. - Array element 1 - (String) Description of the success or error, if available.
- Array element 2 - (String) The current PubNub time expressed as a timetoken.
| Path Parameters |
|---|
pub_key string — REQUIREDYou app’s publish key from Admin Portal. Example:
|
sub_key string — REQUIREDYour app's subscribe key from Admin Portal. Example:
|
channel string — REQUIREDThe channel ID to perform the operation on. Example:
|
callback string — REQUIREDThe JSONP callback name to wrap the function in. Use Example (myCallback):
Example (zero):
|
payload string — REQUIREDSignals are limited to a message payload size of 64 bytes. This limit applies only to the request body, not to the URI or headers. |
| Query Parameters |
|---|
uuid stringA UTF-8 encoded string of up to 92 characters used to identify the client. Example:
|
auth stringString which is either the auth key (Access Manager legacy) or a valid token (Access Manager) used to authorize the operation if access control is enabled. Example:
|
signature stringSignature used to verify that the request was signed with the secret key associated with the subscribe key. If Access Manager is enabled, either a valid authorization token or a signature are required. Check Access Manager documentation for details on how to compute the signature. |
timestamp integerUnix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 seconds offset from NTP. Required if the |
custom_message_type stringPossible values: 3 ≤ length ≤ 50 User-specified message type string - limited by 3-50 case-sensitive alphanumeric characters with only [a-zA-Z0-9-_*] |
| Responses | |||||||
|---|---|---|---|---|---|---|---|
200Publish successful
| |||||||
400Bad Request
| |||||||
403Unauthorized access
| |||||||
413Signal payload size is too large (>=32KiB)
| |||||||
429Request rate limit exceeded
|