# REST API > Below are described the REST APIs of Chat21 - [REST API](#rest-api) - [Authentication](#authentication) - [JWT Authentication](#jwt-authentication) - [Secret Authentication (for admin)](#secret-authentication-for-admin) - [Send a message](#send-a-message) - [Message attributes](#message-attributes) - [Create a Group](#create-a-group) - [Join a Group](#join-a-group) - [Leave a Group](#leave-a-group) - [Set Group members](#set-group-members) - [Delete a message from the personal timeline](#delete-a-message-from-the-personal-timeline) - [Delete a group message for me and other users](#delete-a-group-message-for-me-and-other-users) - [Archive or delete a conversation](#archive-or-delete-a-conversation) - [Create a Contact](#create-a-contact) - [Update my FirstName and Last Name](#update-my-firstname-and-last-name) - [Upload photo profile](#upload-photo-profile) - [Delete photo profile](#delete-photo-profile) - [REST API for Support](#rest-api-for-support) - [Create support request](#create-support-request) - [Rate the request](#rate-the-request) - [Close Support group](#close-support-group) - [Subscribe/unsubscribe to receive emails](#subscribeunsubscribe-to-receive-emails) - [Webhook](#webhook) ## Authentication We support two authentication methods: JWT and Shared Secret ### JWT Authentication Generate a Firebase User JWT token with: ```bash curl 'https://www.googleapis.com/identitytoolkit/v3/relyingparty/verifyPassword?key=' \ -H 'Content-Type: application/json' \ -d '{"email":"", "password":"", "returnSecureToken":true}' ``` The `API_KEY` is the Google Cloud Credentials API Key available under the `APIs and services`: A successful authentication is indicated by a `200` OK HTTP status code. The response contains the Firebase `idToken` and `refreshToken` associated with the existing email/password account. More info here: ### Secret Authentication (for admin) To authenticate you can add the token query parameter to the endpoints. Example: `?token=chat21-secret-orgAa,` You can change the secret token for your installation with `firebase functions:config:set secret.token=MYSECRET` ## Send a message You can send a message making a POST call to the endpoint: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"sender_fullname": "", "recipient_id": "", "recipient_fullname":"","text":"", "channel_type": "", "type": "", "attributes": "", "metadata": ""}' \ 'https://us-central1-.cloudfunctions.net/api//messages' ``` ![successful-message](./successful-message.png) Where: | Variables | Info | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `FIREBASE_ID_TOKEN` | JWT token generated using JWT Authentication Method | | `SENDER_FULLNAME` | Sender Full name. Ex: Maria Leo | | `RECIPIENT_ID` | The recipient id of the message. The recipient id is the user id for direct message or the group id for group messaging. | | `RECIPIENT_FULLNAME` | The Recipient Full name. Ex: Andrea Sponziello | | `MESSAGE_TEXT` | The message text | | `CHANNEL_TYPE` | The channel type. `direct` value for one-to-one direct message and `group` for group messaging | | `TYPE` | The message type. `text` value for textual message and `image` for sending image message (you must set metadata field). | | `ATTRIBUTES` | The message custom attributes. Example: `{"custom_attribute1": "value1"}`. | | `METADATA` | The image properties: `src` is the absolute path, `width` and `height` is the image.
Example: `{ "src": "https://www.tiledesk.com/wp-content/uploads/2018/03/tiledesk-logo.png", "width": 200, "height": 200 }` | | `FIREBASE_PROJECT_ID` | The Firebase project id. | | `APP_ID` | The appid used on multitenant environment. Use `default` as default value | Example. Send a direct message to recipient id U4HL3GWjBsd8zLX4Vva0s7W2FN92 : ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ -d '{"sender_fullname": "Andrea Leo", "recipient_id": "U4HL3GWjBsd8zLX4Vva0s7W2FN92", "recipient_fullname":"Andrea Leo","text":"hello from API"}' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/messages' ``` Example. Send a group message : ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ -d '{"sender_fullname": "Andrea Leo", "recipient_id": "-LKQQxIY4DDyG17FDiOM", "recipient_fullname":"Test group","text":"hello group from API","channel_type":"group"}' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/messages' ``` Example. Send an image to recipient id `U4HL3GWjBsd8zLX4Vva0s7W2FN92`: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ -d '{"sender_fullname": "Andrea Leo", "recipient_id": "U4HL3GWjBsd8zLX4Vva0s7W2FN92", "recipient_fullname":"Andrea Leo","text":"alt text", "type":"image", "metadata": { "src": "https://www.tiledesk.com/wp-content/uploads/2018/03/tiledesk-logo.png", "width": 200, "height": 200 } }' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/messages' ``` Example. Send a message with PDF link to recipient id `U4HL3GWjBsd8zLX4Vva0s7W2FN92`: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ -d '{"sender_fullname": "Andrea Leo", "recipient_id": "U4HL3GWjBsd8zLX4Vva0s7W2FN92", "recipient_fullname":"Andrea Leo","text":"https://www.unipg.it/files/pagine/410/4-PDF-A.pdf", "type":"text" }' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/messages' ``` ### Message attributes With attributes you can add custom attribute to the message as described below but you can also control internal behaviors: - disable push notification for specific message with attributes = `{"sendnotification":false}` - disable conversation model update with attributes = `{"updateconversation":false}` - send info message with blue badge to a chat. It's used to notifiy system events like: member join a chat, member leave a chat, etc.). You can send the info message using attributes = `{"subtype":"info"}` ## Create a Group Create a chat user's group making the following POST call : ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"group_name": "", "group_members": {"":1}}' \ 'https://us-central1-.cloudfunctions.net/api//groups' ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - GROUP_NAME: it's the new group name - MEMBER_ID: it's the user ids of the group members - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value Example: ```bash curl -v -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxxx' \ -d '{"group_name": "TestGroup1", "group_members": {"y4QN01LIgGPGnoV6ql07hwPAQg23":1}}' 'https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/groups' ``` ## Join a Group With this API the user can join (become a member) of an existing group: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"member_id": ""}' \ https://us-central1-.cloudfunctions.net/api//groups//members ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - MEMBER_ID: it's the user id of the user you want to joing (become a member) - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value - GROUP_ID: it's the existing group id Example: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxxx' \ -d '{"member_id": "81gLZhYmpTZM0GGuUI9ovD7RaCZ2"}' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/groups/-L5hnLkBGQoW05ax9ehg/members ``` ## Leave a Group With this API the user can leave of an existing group: ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/api//groups//members/ ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value - GROUP_ID: it's the existing group id - MEMBER_ID: it's the user id of the user you want to leave a group Example: ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxxx' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/groups/-L5hnLkBGQoW05ax9ehg/members/81gLZhYmpTZM0GGuUI9ovD7RaCZ2 ``` ## Set Group members With this API you can set the group members ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"members": {"":1},{"":1}}' \ https://us-central1-.cloudfunctions.net/api//groups//members ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - MEMBER_IDs: it's the user ids of the group members - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value - GROUP_ID: it's the existing group id Example: ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ -d '{"members": {"system":1}}' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/groups/support-group-L5xro2P81zHs7YA7-DX/members ``` ## Delete a message from the personal timeline Delete a message from the personal timeline of a conversation specified by a RECIPIENT_ID ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/api//messages// ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value - RECIPIENT_ID: it's the recipient id - MESSAGE_ID: it's the message id Example: ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImRhNWZiMGJkZTJlMzUwMmZkZTE1YzAwMWE0MWIxYzkxNDc4MTI0NzYifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vY2hhdC12Mi1kZXYiLCJhdWQiOiJjaGF0LXYyLWRldiIsImF1dGhfdGltZSI6MTUyMTE5NTM1MSwidXNlcl9pZCI6IlU0SEwzR1dqQnNkOHpMWDRWdmEwczdXMkZOOTIiLCJzdWIiOiJVNEhMM0dXakJzZDh6TFg0VnZhMHM3VzJGTjkyIiwiaWF0IjoxNTIxMTk1MzUxLCJleHAiOjE1MjExOTg5NTEsImVtYWlsIjoiYW5kcmVhLmxlb0Bmcm9udGllcmUyMS5pdCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJhbmRyZWEubGVvQGZyb250aWVyZTIxLml0Il19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.EOfzeeAWjhTJfI16TyR8e1JRkk_N1ix16AFbaqw6l6YiMBwhxsIya5ZZ4lgIFByKpm0ZUqBvMZ6jbhG368w_wRDNJCDE_08eVGKRGq_428A8f5D6nUB57rRRI1umxj4y50LJ66Px5F7mekcBSPOfPEDrCzn9K7kPj3r1pd-Yc0nhWxTqDKiR_kAFitvmT1ptQGojEfeoIRLoPsv4XtTkWp7NJi-jLZp3dlRAJWp3483lsce3nX2oy4v7OleYIXEzPbJNFW7-qXf04Ovc6__mEShj2RoMntcntxNUsu3rO9ZpJtDIlUK-BMB5XPdEoQ1G9GBcoLRKc76WCqeGKikZIA' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/messages/y4QN01LIgGPGnoV6ql07hwPAQg23/-L7iJ5QljBP7sPkN73Km ``` ## Delete a group message for me and other users Delete a message from all the timelines of a conversation specified by a RECIPIENT_ID ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ 'https://us-central1-.cloudfunctions.net/api//messages//?all=true&channel_type=group' ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value - RECIPIENT_ID: it's the recipient id - MESSAGE_ID: it's the message id Example: ```bash curl -v -X DELETE \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImRhNWZiMGJkZTJlMzUwMmZkZTE1YzAwMWE0MWIxYzkxNDc4MTI0NzYifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vY2hhdC12Mi1kZXYiLCJhdWQiOiJjaGF0LXYyLWRldiIsImF1dGhfdGltZSI6MTUyMTE5NTM1MSwidXNlcl9pZCI6IlU0SEwzR1dqQnNkOHpMWDRWdmEwczdXMkZOOTIiLCJzdWIiOiJVNEhMM0dXakJzZDh6TFg0VnZhMHM3VzJGTjkyIiwiaWF0IjoxNTIxMTk1MzUxLCJleHAiOjE1MjExOTg5NTEsImVtYWlsIjoiYW5kcmVhLmxlb0Bmcm9udGllcmUyMS5pdCIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiZmlyZWJhc2UiOnsiaWRlbnRpdGllcyI6eyJlbWFpbCI6WyJhbmRyZWEubGVvQGZyb250aWVyZTIxLml0Il19LCJzaWduX2luX3Byb3ZpZGVyIjoicGFzc3dvcmQifX0.EOfzeeAWjhTJfI16TyR8e1JRkk_N1ix16AFbaqw6l6YiMBwhxsIya5ZZ4lgIFByKpm0ZUqBvMZ6jbhG368w_wRDNJCDE_08eVGKRGq_428A8f5D6nUB57rRRI1umxj4y50LJ66Px5F7mekcBSPOfPEDrCzn9K7kPj3r1pd-Yc0nhWxTqDKiR_kAFitvmT1ptQGojEfeoIRLoPsv4XtTkWp7NJi-jLZp3dlRAJWp3483lsce3nX2oy4v7OleYIXEzPbJNFW7-qXf04Ovc6__mEShj2RoMntcntxNUsu3rO9ZpJtDIlUK-BMB5XPdEoQ1G9GBcoLRKc76WCqeGKikZIA' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/messages/-L7iM75Pweqz2Atl7w1z/-L7iMFJKt06ixZFG_p4e?all=true&channel_type=group' ``` ## Archive or delete a conversation Archive or delete a conversation from the personal timeline specified by a RECIPIENT_ID ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/api//conversations/?delete= ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value - RECIPIENT_ID: it's the recipient id - delete: (Optional) if true permanently deletes the conversation, if false archives the conversation Example: ```bash curl -v -X DELETE \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjdhM2QxOTA0ZjE4ZTI1Nzk0ODgzMWVhYjgwM2UxMmI3OTcxZTEzYWIifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vY2hhdC12Mi1kZXYiLCJhdWQiOiJjaGF0LXYyLWRldiIsImF1dGhfdGltZSI6MTUyODg3NjAwNywidXNlcl9pZCI6IjVhYWE5OTAyNGMzYjExMDAxNGI0NzhmMCIsInN1YiI6IjVhYWE5OTAyNGMzYjExMDAxNGI0NzhmMCIsImlhdCI6MTUyODg3NjAwNywiZXhwIjoxNTI4ODc5NjA3LCJlbWFpbCI6ImFuZHJlYS5sZW9AZnJvbnRpZXJlMjEuaXQiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiYW5kcmVhLmxlb0Bmcm9udGllcmUyMS5pdCJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.OMLzWOQ9tQroiZuHKZSkWf_JDPAjueYthJXD86ZRIX1LOxlXfewJG3Reb71gXcIggLtrrqfDLw7h9JLSpMuuSl8sZW6ppiMPcwHMdZbFT4kMz-k5wEjkIQaRSua8BKVXnl65TR3hX7xqAvV8F65pRzyndauBOv1mq6o1JfDBKXPDk5O-sXufa3G7ShApjvtW9XAqC6PxnutuoniUGxZhZj1pXn2zlBLFnFcONZNaT1vDfRruAZatmxh41Gc5i04aj0mhqcu2HciJ37qIF2uDY1WkrMs4VUDd-PH1iI4IKKh3k2CXNrPVKQEzR_nL_NyLh_ZnfL8kewLaGFjQOGo0Xg' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/conversations/y4QN01LIgGPGnoV6ql07hwPAQg23/ ``` ## Create a Contact Create a new contact. ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"firstname": "", "lastname": "","email": ""}' \ https://us-central1-.cloudfunctions.net/api//contacts ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIRSTNAME: it's the firstname of the contact - LASTNAME: it's the lastname of the contact - EMAIL: it's the contact email - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value Example: ```bash curl -v -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImMwNmEyMTQ5YjdmOTU3MjgwNTJhOTg1YWRlY2JmNWRlMDQ3Y2RhNmYifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vY2hhdC12Mi1kZXYiLCJhdWQiOiJjaGF0LXYyLWRldiIsImF1dGhfdGltZSI6MTUyMzI2NTgwNiwidXNlcl9pZCI6ImZBSUR4dTAzTnNWUXZQbG9Eb2M2VDdtbVdSNDMiLCJzdWIiOiJmQUlEeHUwM05zVlF2UGxvRG9jNlQ3bW1XUjQzIiwiaWF0IjoxNTIzMjY1ODA2LCJleHAiOjE1MjMyNjk0MDYsImVtYWlsIjoic0BzLml0IiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbInNAcy5pdCJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.kjyCaKs9o5xYVt92gnvGn-7bkI0-HuChU7LxcDFiQ8rz5gJT0B5-R-qHIzifJ42socqWPC-N8hH-ZSiDO8I9PYNaCOcfWuyIw5Fo487MTNJK9pmkjujq8F254zZmhTWPVF1jdWmZg241Z2KoWZckpXThHMbfVPuVH6kENBfqw7vFXXB_blm7kqn2vuzsMYuFyUd7vlUour2KXHVsY5pDagv_EmDcPUhS0akynf1dn8N6j1WK9JV26XMY3yy1t-bMKXq-GPJ5uw-_rmritndqVTea2MS7o5cynFdlrPsqeVMX68hgBBnb-6ZdQMrmOo1nErclbuSZpAqsuQDXEjWhUQ' \ -d '{"firstname": "firstname", "lastname": "lastname","email": "email"}' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/contacts ``` ## Update my FirstName and Last Name Change my first and lastname: ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"firstname": "", "lastname": ""}' \ https://us-central1-.cloudfunctions.net/api//contacts/me ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIRSTNAME: it's the firstname of the contact - LASTNAME: it's the lastname of the contact - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value Example: ```bash curl -v -X PUT \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1ZjUyYTRhNGE5Y2MzNmZjOGEyNWZmMmQ0NzY4NmE0OGM2YjcxZWQifQ.eyJpc3MiOiJodHRwczovL3NlY3VyZXRva2VuLmdvb2dsZS5jb20vY2hhdC12Mi1kZXYiLCJhdWQiOiJjaGF0LXYyLWRldiIsImF1dGhfdGltZSI6MTUyODQ2ODAyMSwidXNlcl9pZCI6IjVhYWE5OTAyNGMzYjExMDAxNGI0NzhmMCIsInN1YiI6IjVhYWE5OTAyNGMzYjExMDAxNGI0NzhmMCIsImlhdCI6MTUyODQ2ODAyMSwiZXhwIjoxNTI4NDcxNjIxLCJlbWFpbCI6ImFuZHJlYS5sZW9AZnJvbnRpZXJlMjEuaXQiLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZW1haWwiOlsiYW5kcmVhLmxlb0Bmcm9udGllcmUyMS5pdCJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.I1Iy3ed1tuujsoz0Ii4UvUzTKQuKGmo94U1UrJ3qG9DhH7f1oTK_v_EF1H8xLonu4qM3RyTXDtHW2Ux8ugZAO3D-wuHLRQGV5zy_csl5Js9wMQvws5q9y-SYmaxxKCgVqGg9VKWjNiq0dk-1RJPOErJragGbi11GrfXAHO6QVBd3gSpdlXikbsYQrqX2w57rw30WW_iVCrjXAqAccXrCoK21vVHJOxX1O4BSgegFuwouvF9wvxhY-APu5lOuo6qMY7zhWHcuEkIk0yK3ortBp2UrRBiqUPzM-EohkeUNGrBp-fdDtAX11z-UfsNQeDVOTRxsEgEKQihn5Ss1zv8Q5g' \ -d '{"firstname": "firstname", "lastname": "lastname"}' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/contacts/me ``` ## Upload photo profile Upload my photo profile ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/api//contacts/me/photo ``` Where : - `FIREBASE_ID_TOKEN`: JWT token generated using JWT Authentication Method - `FIREBASE_PROJECT_ID`: the Firebase project id. Find it on Firebase Console - `APP_ID`: the appid usend on multitenant environment. Use "default" as default value Example: ```bash curl -v -X PUT \ -H 'Authorization: Bearer xxxxx' \ -F "image=@/Users/andrealeo/Downloads/a.jpg" \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/contacts/me/photo ``` ## Delete photo profile Delete my photo profile ```bash curl -X DELETE \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/api//contacts/me/photo ``` Where : - FIREBASE_ID_TOKEN : is a JWT token generated using JWT Authentication Method - FIREBASE_PROJECT_ID: it's the Firebase project id. Find it on Firebase Console - APP_ID: It's the appid usend on multitenant environment. Use "default" as default value Example: ```bash curl -v -X DELETE \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/contacts/me/photo ``` # REST API for Support ## Create support request ```bash curl -X POST \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ -d '{"sender_fullname": "","text":"helo from API","projectid":""}' \ https://us-central1-.cloudfunctions.net/supportapi//requests ``` Example: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -d '{"sender_fullname": "Andrea Leo", "text":"hello from API","projectid":"5ab0f32757066e0014bfd718"}' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/supportapi/tilechat/requests?token=chat21-secret-orgAa,' ``` ## Rate the request ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/supportapi//requests//rate?rating=2&rating_message=ciao ``` Example: ```bash curl -X PUT \ -H 'Content-Type: application/json' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/supportapi/tilechat/requests/support-group-LM879tEdviVwDkNmo94/rate?token=chat21-secret-orgAa,&rating=2&rating_message=ciao' ``` ## Close Support group Where : - : is a JWT token generated using JWT Authentication Method - : is the group id to close - open: (Optional)If true reopen an existing closed group - : it's the Firebase project id. Find it on Firebase Console - : It's the appid usend on multitenant environment. Use "default" as default value ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer " \ https://us-central1-.cloudfunctions.net/supportapi//groups/?open=true/false ``` Example: ```bash curl -X PUT \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer xxxxx' \ https://us-central1-chat-v2-dev.cloudfunctions.net/supportapi/tilechat/groups/support-group-LBqsOVQS59IZPWWY_me ``` ## Subscribe/unsubscribe to receive emails ```bash curl -X POST \ -H 'Content-Type: application/json' \ -d '{"user_id": "", "is_subscribed": ""}' \ https://us-central1-.cloudfunctions.net/api//users//settings/email?token=chat21-secret-orgAa, ``` Example: ```bash curl -X POST \ -H 'Content-Type: application/json' \ -d '{"user_id": "u2K7nLo2dTZEOYYTykrufN6BDF92", "is_subscribed": "true"}' \ https://us-central1-chat-v2-dev.cloudfunctions.net/api/tilechat/users/u2K7nLo2dTZEOYYTykrufN6BDF92/settings/email?token=chat21-secret-orgAa, ``` ## Webhook - Enable webhook with `firebase functions:config:set webhook.enabled=true` - Set on new message webhook url with : `firebase functions:config:set webhook.onmessage.url=http://localhost:3000/requests` TODO ```bash curl -v -X GET \ -H 'Content-Type: application/json' \ 'https://us-central1-chat-v2-dev.cloudfunctions.net/webhookapi/?hub.mode=subscribe&hub.verify_token=webhooksecret' ```