Manage elements in a message queue.

By defining the values of key-value pairs for the elements in the chat room queue, the elements can be managed using various methods.

Add or update an element

Add or update an element in a chat room queue.
If the element added by User A is updated by User B, the owner of the element is User B.

URL

httpPOST  https://api.netease.im/nimserver/chatroom/queueOffer.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

Request parameters

• For information about the header in a POST request, see Overview.
• The settings of the body in a POST request:

Example

Example request (cURL)

curlcurl -X POST -H "CheckSum: 32dc17***c9367e7" -H "AppKey: fe416640***ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Cache-Control: no-cache" -H "Postman-Token: b9550dce-74c1-9606-0084-71dd8ec201b6" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&key=1111&value=66666' "https://api.netease.im/nimserver/chatroom/queueOffer.action"

Response

json"Content-Type": "application/json; charset=utf-8"
{
  "desc": {
  },
  "code": 200
}

Add multiple elements

Add multiple elements in a chat room queue

• If the chat room queue is not initialized, the queue will be automatically initialized and the notification for queue initialization will be received.
• If the account to which the queue element belongs is offline and not the creator of the chat room, adding elements will fail.

URL

httpPOST  https://api.netease.im/nimserver/chatroom/queueBatchOffer.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

Request parameters

• For information about the header in a POST request, see Overview.
• The settings of the body in a POST request:

[
    {
        "key": "key01",   //Element key
        "value": "{\"priority\":10}", //Element value
        "accid":"user01", //Account to which an element belongs
        // if accid is unspecified, the default value is operator
        "transient":true //Whether elements are deleted when leaving a chat room.
        //If transient is unspecified, the default value is used.
    }
]

Example

Example request (cURL)

curlcurl -X POST  -H 'appkey: fe416640***47ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f54***f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' --data-urlencode 'roomid=64' --data-urlencode 'operator=user01' --data-urlencode 'transient=false' --data-urlencode 'needNotify=false' --data-urlencode 'elements=[{"key":"key01","value":"{\"priority\":10}","accid":"user01","transient":true}]'  "https://api.netease.im/nimserver/chatroom/queueBatchOffer.action"

Response

json
"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "desc": {
        "failedKeys": [  //Keys that failed to be added.
            "key01"
        ]
    }
}

Update multiple elements in a queue

Update multiple elements in a queue in chat rooms
If the element added by User A is updated by User B, the owner of the element is User B.

URL

httpPOST https://api.netease.im/nimserver/chatroom/queueBatchUpdateElements.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

Request parameters

• For information about the header in a POST request, see Overview.
• The settings of the body in a POST request:

Example

Example request (cURL)

curlcurl -X POST  -H 'appkey: fe4166***47ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a***75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'roomid=18&operator=xiaoming01&elements=%7b%22k1%22%3a%22v1%22%2c%22k2%22%3a%22v2%22%7d' "https://api.netease.im/nimserver/chatroom/queueBatchUpdateElements.action"

Response

json
"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "desc":{
        "noExistElementKey":[
            "k1"
        ]
    }
}

List all elements in a queue

URL

httpPOST https://api.netease.im/nimserver/chatroom/queueList.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

Request parameters

• For information about the header in a POST request, see Overview.
• The settings of the body in a POST request:

Example

Example request (cURL)

curlcurl -X POST -H "CheckSum: 37dc87d***kbf049c9367e7" -H "AppKey: fe416640c8e8a7***47ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&key=1111'    "https://api.netease.im/nimserver/chatroom/queueList.action"

Response

json"Content-Type": "application/json; charset=utf-8"
{
  "desc": { 
    "list": [ 
      { 
        "33333": "33333" 
      } 
    ] 
  },
  "code": 200
}

Get elements from a queue

URL

httpPOST https://api.netease.im/nimserver/chatroom/queuePoll.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

Request parameters

• For information about the header in a POST request, see Overview.
• The settings of the body in a POST request:

Example

Example request (cURL)

curlcurl -X POST -H "CheckSum: 37dc1***9bbf049c9367e7" -H "AppKey: fe416***19e1847ad2547" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'roomid=36&key=333334444'   "https://api.netease.im/nimserver/chatroom/queuePoll.action"

Response

json"Content-Type": "application/json; charset=utf-8"
{
  "desc": { 
    "value": "66666", 
    "key": "1111" 
  },
  "code": 200
}

Get elements of a specified queue

Get elements of a specified queue by element key.

URL

httpPOST https://api.netease.im/nimserver/chatroom/queueMultiGet.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

Request parameters

• For information about the header in a POST request, see Overview.
• The settings of the body in a POST request:

Example

Example request (cURL)

curlcurl -X POST  -H 'appkey: fe4***d2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5***65495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'roomid=64&keys=%5B%22key1%22%2C%22key2%22%2C%22key3%22%5D' "https://api.netease.im/nimserver/chatroom/queueMultiGet.action"

Response

json
"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "desc": {
        "list": [
            {
                "key1": "value1"
            },
            {
                "key2": "value2"
            },
            {
                "key3": "value3"
            }
        ]
    }
}

Status codes

The status code is returned in the response body. For more information, see Status codes.