RESTful API List

Last updated: 2020-08-03 11:19:06

    Account Management

    Feature Description API
    Import an account. v4/im_open_login_svc/account_import
    Batch import accounts. v4/im_open_login_svc/multiaccount_import
    Delete accounts. v4/im_open_login_svc/account_delete
    Check accounts. v4/im_open_login_svc/account_check
    Invalidate the login status of an account. v4/im_open_login_svc/kick
    Query the login status of an account. v4/openim/querystate

    One-to-one Message

    Feature Description API
    Send a one-to-one message. v4/openim/sendmsg
    Batch send one-to-one messages. v4/openim/batchsendmsg
    Import one-to-one messages. v4/openim/importmsg
    Query one-to-one messages. v4/openim/admin_getroammsg
    Recall one-to-one messages. v4/openim/admin_msgwithdraw

    Push Notifications

    Feature Description API
    Push to All Users v4/all_member_push/im_push
    Set App Attribute Names v4/all_member_push/im_set_attr_name
    Obtain App Attribute Names v4/all_member_push/im_get_attr_name
    Obtain User Attributes v4/all_member_push/im_get_attr
    Set User Attributes v4/all_member_push/im_set_attr
    Delete User Attributes v4/all_member_push/im_remove_attr
    Obtain User Tags v4/all_member_push/im_get_tag
    Add User Tags v4/all_member_push/im_add_tag
    Delete User Tags v4/all_member_push/im_remove_tag
    Delete All Tags of a User v4/all_member_push/im_remove_all_tags

    Profile Management

    Feature Description API
    Configure profiles. v4/profile/portrait_set
    Pull profiles. v4/profile/portrait_get

    Relationship Chain Management

    Feature Description API
    Add friends. v4/sns/friend_add
    Import friends. v4/sns/friend_import
    Delete friends. v4/sns/friend_delete
    Delete all friends. v4/sns/friend_delete_all
    Verify friends. v4/sns/friend_check
    Pull friends. v4/sns/friend_get
    Pull specific friends. v4/sns/friend_get_list
    Add users to blocklist. v4/sns/black_list_add
    Remove users from blocklist. v4/sns/black_list_delete
    Pull a blocklist. v4/sns/black_list_get
    Verify a blocklist. v4/sns/black_list_check
    Add a list. v4/sns/group_add
    Delete a list. v4/sns/group_delete

    Group Management

    Feature Description API
    Create a group. v4/group_open_http_svc/create_group
    Obtain detailed group profiles. v4/group_open_http_svc/get_group_info
    Obtain detailed group member profiles. v4/group_open_http_svc/get_group_member_info
    Modify basic group profiles. v4/group_open_http_svc/modify_group_base_info
    Add group members. v4/group_open_http_svc/add_group_member
    Delete group members. v4/group_open_http_svc/delete_group_member
    Modify group member profiles. v4/group_open_http_svc/modify_group_member_info
    Disband groups. v4/group_open_http_svc/destroy_group
    Obtain the groups a user has joined. v4/group_open_http_svc/get_joined_group_list
    Query the identity of a user in a group. v4/group_open_http_svc/get_role_in_group
    Mute and unmute group members. v4/group_open_http_svc/forbid_send_msg
    Obtain muted users in a group. v4/group_open_http_svc/get_group_shutted_uin
    Send ordinary messages in a group. v4/group_open_http_svc/send_group_msg
    Send system messages in a group. v4/group_open_http_svc/send_group_system_notification
    Recall group messages. v4/group_open_http_svc/group_msg_recall
    Transfer a group. v4/group_open_http_svc/change_group_owner
    Import basic group profiles. v4/group_open_http_svc/import_group
    Import group messages. v4/group_open_http_svc/import_group_msg
    Import group members. v4/group_open_http_svc/import_group_member
    Configure unread message counts. v4/group_open_http_svc/set_unread_msg_num
    Delete messages sent by the specified user. v4/group_open_http_svc/delete_group_msg_by_sender
    Pull roaming group messages. v4/group_open_http_svc/group_msg_get_simple

    Global Mute Management

    Feature Description API
    Configure global mute. v4/openconfigsvr/setnospeaking
    Query global mute. v4/openconfigsvr/getnospeaking

    Operations Management

    Feature Description API
    Download message history. v4/open_msg_svc/get_history
    Pull operations data. v4/openconfigsvr/getappinfo
    Obtain Server IP Addresses v4/ConfigSvc/GetIPList

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help