Qwil Messenger has a range of open APIs that can be used to perform a wide array of functions available on the platform.
\nThere are three categories of API endpoints: System, Master & User endpoints.
\nUsing the endpoints requires authentication of each call via an API key and secret.
\nSystem API keys are geared towards automating and simplifying the administration of your organisation, such as managing users, groups, invitations, and exporting your organisation's data. System API keys relate to entity-service endpoints.
\nMaster User API keys provide access to chat and contact related functionality. You can use the Chat Butler to send organisation- wide messages, automate your client engagement strategies, or integrate your other systems to create chats directly on Qwil Messenger.
\nWith Master User API Keys you can send messages on behalf of any user. These keys relate to chat-service endpoints.
\nUser API keys provide staff members access to chat and contact related functionality if enabled in your organisation. You can use keys automate your client engagement strategies - automatically create chats with your clients, and place them in the archive until you get a reply, or integrate your other systems to create chats directly on Qwil Messenger.
\nThis documentation will provide all the information required to integrate and automate Qwil Messenger while maintaining secure, compliant conversations.
\nFor more information please visit our Help Centre or Contact Us.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10393016","collectionId":"aebee031-f750-4c68-b41b-6feaa9685ad2","publishedId":"UVsEWUi5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"272929","highlight":"EF5B25"},"publishDate":"2022-03-08T11:32:45.000Z"},"item":[{"name":"System APIs","item":[{"name":"chats","item":[{"name":"documents","id":"2fe7003b-1471-4fc5-8920-4d62416ccf8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-SYS-API-KEY-SECRET","value":"{{X-SYS-API-KEY-SECRET}}","type":"text"},{"key":"X-SYS-API-KEY","value":"{{X-SYS-API-KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chat_uuid\": \"uuid\", \n \"seq\": \"integer()\"\n}"},"url":"https://{{environment}}.qwil.io/entity-service/sys-api/chats/documents","description":"Description:
\nThis API will download a document from a chat.
\nPermissions:
\nThis key can perform data reviewer actions
\nExceptions:
\nDescription:
\nThis API will return a list of all of a user's chats along with chat metadata.
\nPermissions:
\nThis key can perform data reviewer actions
\nExceptions:
\nDescription:
\nThis API will return all documents, images, links or messages sent within a chat.
\nPermissions:
\nThis key can perform data reviewer actions
\nExceptions:
\nDescription:
\nThis API will return messages sent within a chat in sequence.
\nPermissions:
\nThis key can perform data reviewer actions
\nExceptions:
\nDescription:
\nThis API will get a user's tenancy membership information.
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API will download the avatar of a user.
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API will reset a user's avatar to the default.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will update a user's avatar.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will create a client or staff entity user and optionally sends out invitation.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will create a client or staff entity user, as well as an option to create a new group while adding group members and optionally sends out invitation.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API call deletes an entity-membership.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will update the contact(public), emails of a user.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will create add a user to contact groups.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will get the contact group memberships of a user.
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API will resend an invitation to an already pending user.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API updates a user's pending invitation with a Qwil ID. This will allow a pending invitation to be merged with an existing Qwil account, instead of having a new user created on accepting the invite.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will list users within a tenancy.
\nentity_user_xref_type: 2: client, 1:staff, 3:client+staff
\nentity_user_xref_status_type: 1: active, 2: pending, 3: active+pending, 4:removed+cancelled, 5:all
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API will update the contact(public) phone numbers of a user.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will update the name and job title of a user.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will suspend an active entity membership.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will undo a suspension of an entity membership, returning them to active status.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API updates account details of an entity membership.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API retrieves group details. The payload must include either the group_uuid or identifier, but not both.
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API will create a group with a name, description, and identifier. The identifier has to be a unique, or an empty string.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API deletes an existing group. The group should not have any active/pending members, and should not leave a client user without a group membership.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API adds a contact group membership for one or many users.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API removes a user from a contact group.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nDescription:
\nThis API will list members of a contact group.
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API lists groups of an entity. The group statuses will be returned as follows:
\ngroup_status_type: 1=active, 2=inactive, 3=all
\nPermissions:
\nThis key can perform read-only admin actions
\nExceptions:
\nDescription:
\nThis API updates an existing group with a name, description, and identifier. The identifier must be unique, or an empty string.
\nPermissions:
\nThis key can perform write-only admin actions
\nExceptions:
\nQwil Messenger offers 36 System APIs enabling Enterprise customers to perform group and user management functions. Actions performed by APIs follow the same rules as conventionally using Qwil, but allow greater freedom for automation and integration.
\nThis documentation will help you develop programmes to automate your organisations messaging using the following API calls.
\nYou will need to provide certain permissions for your keys to perform certain functions. These are outlined with each endpoint. The options are:
\nTo read more about this and learn how to set up and maintain your System API keys, click here.
\n","_postman_id":"fb309b86-db97-41e3-b35c-a70259270d61"},{"name":"Master APIs","item":[{"name":"butler","item":[{"name":"butler-says/send-file","id":"454d5436-6297-4109-9cdf-3f25b0eefdb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-MASTER-USER-API-KEY-SECRET","value":"{{X-MASTER-USER-API-KEY-SECRET}}","type":"text"},{"key":"X-MASTER-USER-API-KEY","value":"{{X-MASTER-USER-API-KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"caption\": \"string(min=1, max=5000) (optional)\", \n \"document_uuid\": \"uuid (optional)\", \n \"entity_user_xref_uuid\": \"uuid\", \n \"file\": \"filestorage (optional)\", \n \"reply_to_seq\": \"integer(min=0) (optional)\", \n \"thumbnail\": \"b64_jpg (optional)\"\n}"},"url":"https://{{environment}}.qwil.io/chat-service/api/chats/butler-says/send-file?on-behalf-of={{entity_user_xref_uuid}}","description":"Description:
\nThis API sends a file as a message attachment to a butler chat. Either document_uuid or image must be provided, but not both. Use the former to post with a pre-uploaded file or the latter to upload a new one. Optionally provide a custom thumbnail. If provided, this must be a B64-encoded JPEG.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API sends image message to a butler chat. Either document_uuid or image must be provided, but not both. Use the former to post with a pre-uploaded image or the latter to upload a new one. Only JPG and PNG image types allowed, with max size of 1MB.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API sends a text based message to a user through the butler chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API retrieves a chat and its membership details.
\nPermissions:
\nThis key can perform read-only chat actions
\nExceptions:
\nDescription:
\nThis API will, depending on the boolean entry, archive or unarchive a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API invites other entity users to a specific chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API creates a new chat with the given title and members.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API functions as the act of a user leaving a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API will return messages in sequence from a chat.
\nPermissions:
\nThis key can perform read-only chat actions
\nExceptions:
\nDescription:
\nThis API will send a gif as message to a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API sends a file as a message attachment to a chat. Either the document_uuid or the file must be provided, but not both. Use the former to post with a pre-uploaded file or the latter to upload a new one. Optionally provide a custom thumbnail. If provided, this must be a B64-encoded JPEG.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API sends an image as a message to a chat. Either document_uuid or image must be provided, but not both. Use the former to post with a pre-uploaded image or the latter to upload a new one. Only JPG and PNG image types allowed, with max size of 1MB.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API sends a text-based message to a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API creates a biometric approval request for a specific user within a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\n","urlObject":{"protocol":"https","path":["chat-service","api","chats","biometrics-requests","create"],"host":["{{environment}}","qwil","io"],"query":[{"key":"on-behalf-of","value":"{{entity_user_xref_uuid}}"}],"variable":[]}},"response":[],"_postman_id":"1020ccdd-55d6-4b5d-b83d-74424b7f55c1"},{"name":"signature-requests/create","id":"75e0ae4b-0750-4165-98c0-f1491b270254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-MASTER-USER-API-KEY-SECRET","value":"{{X-MASTER-USER-API-KEY-SECRET}}"},{"key":"X-MASTER-USER-API-KEY","value":"{{X-MASTER-USER-API-KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"caption\": \"string(min=1, max=250) (optional)\",\n \"chat_uuid\": \"uuid\",\n \"include_requester_signature\": \"boolean() (optional)\",\n \"pdf\": \"filestorage\",\n \"signer_entity_user_xref_uuid\": \"uuid\"\n}"},"url":"https://{{environment}}.qwil.io/chat-service/api/chats/signature-requests/create?on-behalf-of={{entity_user_xref_uuid}}","description":"Description:
\nThis API creates a signature request within a specific chat.
\nPermissions:
\nThis key can perform write-only chat actions
\n","urlObject":{"protocol":"https","path":["chat-service","api","chats","signature-requests","create"],"host":["{{environment}}","qwil","io"],"query":[{"key":"on-behalf-of","value":"{{entity_user_xref_uuid}}"}],"variable":[]}},"response":[],"_postman_id":"75e0ae4b-0750-4165-98c0-f1491b270254"},{"name":"notify","id":"b722c35a-1ed4-4202-9d2d-ae929332ea4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-MASTER-USER-API-KEY-SECRET","value":"{{X-MASTER-USER-API-KEY-SECRET}}","type":"text"},{"key":"X-MASTER-USER-API-KEY","value":"{{X-MASTER-USER-API-KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chat_uuid\": \"uuid\", \n \"notify\": \"boolean()\"\n}"},"url":"https://{{environment}}.qwil.io/chat-service/api/chats/notify?on-behalf-of={{entity_user_xref_uuid}}","description":"Description:
\nThis API sets, depending on the boolean entry, whether or not a chat gives notifications.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API will remove a user from a chat
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API will rename a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API will lookup a user by email or identifier or uuid.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nDescription:
\nThis API will lookup and retrieve contact avatar by uuid or identifier or email.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nDescription:
\nThis API will get a list of contacts;
\ncontact_type: 0: client+staff (this is to get the default list), 1: staff (this is useless) 2: client 3: directory 4: everyone (if requester==client = client+staff, if requester==staff, client+staff+directory) cursor_dt is only present in response in page 1
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nDescription:
\nThis API will get a user's membership information.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nQwil Messenger offers 23 Master APIs enabling Enterprise customers to perform chat and contact functions ranging from sending a simple message on someone's behalf to getting your contact list. Actions performed by APIs follow the same rules as conventionally using Qwil, but allow greater freedom for automation and integration.
\nThis documentation will help you develop programmes to automate your organisations messaging using the following API calls.
\nYou will need to provide certain permissions for your keys to perform certain functions. These are outlined with each endpoint. The options are:
\nTo read more about this and learn how to set up and maintain your Master API keys, click here.
\n","_postman_id":"90becc90-0a36-4e57-9383-b66c031b2b88"},{"name":"User APIs","item":[{"name":"chats","item":[{"name":"chats","id":"257268b6-2cfa-4f54-9b1a-2327f8f15b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-USER-API-KEY-SECRET","value":"{{X-USER-API-KEY-SECRET}}","type":"text"},{"key":"X-USER-API-KEY","value":"{{X-USER-API-KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chat_uuid\": \"uuid\"\n}"},"url":"https://{{environment}}.qwil.io/chat-service/api/chats?on-behalf-of={{entity_user_xref_uuid}}","description":"Description:
\nThis User API retrieves a user's chat and its membership details.
\nPermissions:
\nThis key can perform read-only chat actions
\nExceptions:
\nDescription:
\nThis User API will, depending on the boolean entry, archive or unarchive a chat the user's chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API creates a new chat with the given title and members.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API invites other entity users in the user's contact groups to a specific chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API allows a user to leave a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API will return messages in sequence from a user's chat.
\nPermissions:
\nThis key can perform read-only chat actions
\nExceptions:
\nDescription:
\nThis User API will send a gif as message to a user's chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API sends a file as a message attachment to a user's chat. Either the document_uuid or the file must be provided, but not both. Use the former to post with a pre-uploaded file or the latter to upload a new one. Optionally provide a custom thumbnail. If provided, this must be a B64-encoded JPEG.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API sends an image as a message to a user's chat. Either document_uuid or image must be provided, but not both. Use the former to post with a pre-uploaded image or the latter to upload a new one. Only JPG and PNG image types allowed, with max size of 1MB.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API sends a text-based message to a user's chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis API creates a biometric approval request for a specific user within a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\n","urlObject":{"protocol":"https","path":["chat-service","api","chats","biometrics-requests","create"],"host":["{{environment}}","qwil","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"063d5fd9-db67-4752-93e5-7da539ce9a18"},{"name":"messages/send-text Copy 2","id":"c8ccd8e2-8b01-4d2e-94fa-a507db7384d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-USER-API-KEY-SECRET","value":"{{X-USER-API-KEY-SECRET}}"},{"key":"X-USER-API-KEY","value":"{{X-USER-API-KEY}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"caption\": \"string(min=1, max=250) (optional)\",\n \"chat_uuid\": \"uuid\",\n \"include_requester_signature\": \"boolean() (optional)\",\n \"pdf\": \"filestorage\",\n \"signer_entity_user_xref_uuid\": \"uuid\"\n}"},"url":"https://{{environment}}.qwil.io/chat-service/api/chats/signature-requests/create","description":"Description:
\nThis API creates a signature request within a specific chat.
\nPermissions:
\nThis key can perform write-only chat actions
\n","urlObject":{"protocol":"https","path":["chat-service","api","chats","signature-requests","create"],"host":["{{environment}}","qwil","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8ccd8e2-8b01-4d2e-94fa-a507db7384d4"},{"name":"notify","id":"c65a8a5a-6c9e-4a4f-841d-d4b54b504c63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-USER-API-KEY-SECRET","value":"{{X-USER-API-KEY-SECRET}}","type":"text"},{"key":"X-USER-API-KEY","value":"{{X-USER-API-KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"chat_uuid\": \"uuid\", \n \"notify\": \"boolean()\"\n}"},"url":"https://{{environment}}.qwil.io/chat-service/api/chats/notify?on-behalf-of={{entity_user_xref_uuid}}","description":"Description:
\nThis User API sets, depending on the boolean entry, whether or not a chat is muted for the user.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API will remove a user from a chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API will rename a user's chat.
\nPermissions:
\nThis key can perform write-only chat actions
\nExceptions:
\nDescription:
\nThis User API will lookup a user's contacts by email or identifier or uuid.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nDescription:
\nThis User API will lookup and retrieve contact avatar by uuid or identifier or email.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nDescription:
\nThis User API will get a list of user's contacts;
\ncontact_type: 0: client+staff (this is to get the default list), 1: staff (this is useless) 2: client 3: directory 4: everyone (if requester==client = client+staff, if requester==staff, client+staff+directory) cursor_dt is only present in response in page 1.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nDescription:
\nThis API will get a user's membership information.
\nPermissions:
\nThis key can perform read-only contact actions
\nExceptions:
\nQwil Messenger offers 19 User APIs enabling Enterprise users to perform chat and contact functions ranging from sending a simple message to getting your contact list. Actions performed by APIs follow the same rules as conventionally using Qwil, but allow greater freedom for automation and integration.
\nThis documentation will help you develop programmes to automate your organisations messaging using the following API calls.
\nYou will need to provide certain permissions for your keys to perform certain functions. These are outlined with each endpoint. The options are:
\nTo read more about this and learn how to set up and maintain your User API keys, click here.
\n","_postman_id":"7baa78f6-33cf-4972-a1f5-0703ab331459"}]}