The Connectus API employs Basic Auth and API Key methods to ensure secure access to its services. With Basic Auth, you must send your username and password with each request. You also need to send an authorization token. All the data must be obtained from https://plataforma.connectus.la/account
\nBasic Authentication is a simple authentication method built into the HTTP protocol. It requires the client to send a username and password encoded in Base64 format as part of the Authorization header in each request. The format of the header is
\nAuthorization: Basic <base64_encoded_username:password>\n\nTo generate this value, concatenate your username and password using a colon (:), then encode the resulting string in Base64. For example, if your username is user and your password is pass, the string user:pass is encoded to dXNlcjpwYXNz, and the final header would be:
\nAuthorization: Basic dXNlcjpwYXNz\n\nHere is a python example for the authentication header generation
\nimport base64\nusername = \"user\"\npassword = \"pass\"\ncredentials = f\"{username}:{password}\"\nencoded_credentials = base64.b64encode(credentials.encode('utf-8')).decode('utf-8')\nheaders = {\n \"Authorization\": f\"Basic {encoded_credentials}\"\n}\nprint(headers)\n\nTo receive SMS status updates and SMS replies, ConnectUs provides configurable webhooks at:
\nhttps://plataforma.connectus.la/es/admin/account_and_company/index
\nThis webhook delivers a POST HTTP request in the following format:
\n{\n \"status\": \"ENTREGADO\",\n \"id_sms\": \"c7925e64955445bbbe0ae39339b9514c\"\n}\n\nThe possible statuses for the unique SMS identifier (id_sms) are:
\nPROGRAMADO, EN_COLA, NUMERO_INVALIDO, ENVIADO_A_CARRIER, ESPERANDO_RESPUESTA, NO_ENTREGABLE, ENTREGADO
This webhook delivers a POST HTTP request in the following format:
\n{\n \"src_provider\": \"Wom\",\n \"id_sms\": \"f73a185dc7614ea4bac7c59146a67e6d\",\n \"src_number\": \"56990324203\",\n \"dst_number\": \"56442330001\",\n \"sms_content\": \"Hello connectus!\",\n \"sms_content_binary\": \"486f6c6120636f6e6e656374757321\"\n}\n\nThis endpoint is used to send a simple SMS to a specified destination number.
\nSend one time password message. The cost of these messages is higher than regular delivery.
\nThis endpoint retrieves the status of a sent SMS, the delivery parameter via a GET request through the URL.
\nPossible statuses:
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","sms",":id"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[{"description":{"content":"The ID of the SMS whose status is to be retrieved
\n","type":"text/plain"},"type":"any","value":"Sms ID","key":"id"}]}},"response":[{"id":"d5427a95-8486-425b-958c-eda124dedac2","name":"SMS status retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Retrieves all SMS associated with a delivery.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","sms","delivery_info"],"host":["https://plataforma.connectus.la"],"query":[{"description":{"content":"The ID of the delivery from which you want to GET the SMS
\n","type":"text/plain"},"key":"delivery_id","value":"This endpoint retrieves SMS messages sent within the specified date range. The dates are provided through the begin_date and end_date query parameters.
Start date for filtering sent SMS. Only SMS sent from this date (inclusive) will be included. Format: YYYY-MM-DD.
\n","type":"text/plain"},"key":"begin_date","value":"End date for filtering sent SMS. Only SMS sent up to this date (inclusive) will be included. Format: YYYY-MM-DD.
\n","type":"text/plain"},"key":"end_date","value":"This SMS API provides three main endpoints to manage SMS communications securely. Users can send individual SMS messages, retrieve the status of a specific SMS, and fetch statuses of SMS messages over a specified date range. The date parameters should be provided in the YYYY-MM-DD format. User roles, which control access to these endpoints, must be assigned by an administrator through the platform available at
\nhttps://plataforma.connectus.la/es/admin/account_and_company/index.
\nEach endpoint supports API Key authentication methods to ensure secure access.
\n","_postman_id":"c141e3b6-5ca8-4117-8488-cefdd13321e4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Subclient","item":[{"name":"Retrieve client by ID","id":"cc8ff81d-95ec-420f-9be1-668758272a3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://plataforma.connectus.la/api_v3/clients/:id","description":"Retrieves the details of a client, including both their balances and identification.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","clients",":id"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[{"description":{"content":"The ID of the Client to be retrieved
\n","type":"text/plain"},"type":"any","value":"Client ID","key":"id"}]}},"response":[{"id":"e04ea819-961d-478f-8159-a86d30039c0f","name":"Client retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"https://plataforma.connectus.la/api_v3/clients/:id","protocol":"https","host":["plataforma","connectus","la"],"path":["api_v3","clients",":id"],"variable":[{"key":"id","value":"lpa22mae"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 11,\r\n \"id_account\": 2311,\r\n \"name\": \"colegioranitadedarwin\",\r\n \"balance\": 12,\r\n \"avatar\": null,\r\n \"id_unique\": \"lpa22mae\",\r\n \"deleted\": \"F\",\r\n \"created_at\": \"Mon, 09 Jan 2023 13:30:07.000000000 -03 -03:00\",\r\n \"updated_at\": \"Mon, 09 Jan 2023 13:30:07.000000000 -03 -03:00\"\r\n}"},{"id":"21203a76-b98a-4596-a782-496ba9038012","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/clients/:id","host":["{{baseUrl}}"],"path":["clients",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cc8ff81d-95ec-420f-9be1-668758272a3f"},{"name":"Update client by ID","id":"0074fb6a-480f-41cd-bfae-4ed69dced6c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test2\"\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/clients/:id","description":"Updates the name of a subclient identified by the provided ID.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","clients",":id"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[{"description":{"content":"ID of client who wants to be updated
\n","type":"text/plain"},"type":"any","value":"Client ID","key":"id"}]}},"response":[{"id":"3d9d5624-416a-44a6-b4cc-82760600442b","name":"Client updated","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test2\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://plataforma.connectus.la/api_v3/clients/:id","protocol":"https","host":["plataforma","connectus","la"],"path":["api_v3","clients",":id"],"variable":[{"key":"id","value":"lpa22mae"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 11,\n \"id_account\": 2311,\n \"name\": \"colegioupdated\",\n \"balance\": 15,\n \"avatar\": null,\n \"id_unique\": \"lpa22mae\",\n \"deleted\": \"F\",\n \"created_at\": \"Mon, 09 Jan 2023 13:30:07.000000000 -03 -03:00\",\n \"updated_at\": \"Mon, 09 Jan 2023 13:30:07.000000000 -03 -03:00\"\n}"},{"id":"cfd843e4-8361-4c84-9ed9-4892ad78b635","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test2\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{baseUrl}}/clients/:id","host":["{{baseUrl}}"],"path":["clients",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0074fb6a-480f-41cd-bfae-4ed69dced6c5"},{"name":"Retrieve all clients","id":"053b3ddd-9ee8-4413-b5e5-9c8c7d1ea58a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://plataforma.connectus.la/api_v3/clients","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","clients"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[{"id":"dfb9b789-8b5c-49ad-a673-38f3799e6f61","name":"All clients retrieved","originalRequest":{"method":"GET","header":[],"url":"https://plataforma.connectus.la/api_v3/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"free_sms_balance_by_country\": [\n {\n \"id_country\": 1,\n \"country_name\": \"Chile\",\n \"balance\": 178808\n },\n {\n \"id_country\": 2,\n \"country_name\": \"Mexico\",\n \"balance\": 10393\n },\n {\n \"id_country\": 3,\n \"country_name\": \"Peru\",\n \"balance\": 56026\n },\n {\n \"id_country\": 4,\n \"country_name\": \"Ecuador\",\n \"balance\": 1657\n },\n {\n \"id_country\": 5,\n \"country_name\": \"Estados Unidos\",\n \"balance\": 31254\n },\n {\n \"id_country\": 6,\n \"country_name\": \"Colombia\",\n \"balance\": 11582\n },\n {\n \"id_country\": 7,\n \"country_name\": \"Argentina\",\n \"balance\": 7467\n },\n {\n \"id_country\": 8,\n \"country_name\": \"Brasil\",\n \"balance\": 0\n },\n {\n \"id_country\": 10,\n \"country_name\": \"Costa Rica\",\n \"balance\": 994\n },\n {\n \"id_country\": 12,\n \"country_name\": \"Uruguay\",\n \"balance\": 0\n },\n {\n \"id_country\": 13,\n \"country_name\": \"Paraguay\",\n \"balance\": 5\n },\n {\n \"id_country\": 14,\n \"country_name\": \"Bolivia\",\n \"balance\": 0\n },\n {\n \"id_country\": 15,\n \"country_name\": \"Guatemala\",\n \"balance\": 10\n }\n ],\n \"free_email_balance\": 64025,\n \"free_whatsapp_balance\": 0,\n \"clients\": [\n {\n \"name\": \"Matias 2\",\n \"id_unique\": \"da82la12\",\n \"created_at\": \"2019-07-17T01:35:41.000-04:00\",\n \"updated_at\": \"2019-07-17T03:51:54.000-04:00\",\n \"balance\": {\n \"sms_balance\": [\n {\n \"id_country\": 1,\n \"country_name\": \"Chile\",\n \"balance\": 78\n },\n {\n \"id_country\": 2,\n \"country_name\": \"Mexico\",\n \"balance\": 0\n },\n {\n \"id_country\": 3,\n \"country_name\": \"Peru\",\n \"balance\": 0\n },\n {\n \"id_country\": 4,\n \"country_name\": \"Ecuador\",\n \"balance\": 0\n },\n {\n \"id_country\": 5,\n \"country_name\": \"Estados Unidos\",\n \"balance\": 0\n },\n {\n \"id_country\": 6,\n \"country_name\": \"Colombia\",\n \"balance\": 43\n },\n {\n \"id_country\": 7,\n \"country_name\": \"Argentina\",\n \"balance\": 0\n },\n {\n \"id_country\": 8,\n \"country_name\": \"Brasil\",\n \"balance\": 0\n },\n {\n \"id_country\": 10,\n \"country_name\": \"Costa Rica\",\n \"balance\": 0\n },\n {\n \"id_country\": 12,\n \"country_name\": \"Uruguay\",\n \"balance\": 0\n },\n {\n \"id_country\": 13,\n \"country_name\": \"Paraguay\",\n \"balance\": 0\n },\n {\n \"id_country\": 14,\n \"country_name\": \"Bolivia\",\n \"balance\": 0\n },\n {\n \"id_country\": 15,\n \"country_name\": \"Guatemala\",\n \"balance\": 0\n }\n ],\n \"email_balance\": 0,\n \"whatsapp_balance\": 0\n }\n }\n ]\n }\n}"},{"id":"afde6c19-77dc-4a37-8a1a-357e710110e1","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/clients"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"053b3ddd-9ee8-4413-b5e5-9c8c7d1ea58a"},{"name":"Add balance to a client by client ID","id":"8d2d6ed4-0edb-449e-a802-c7f873700a13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 28,\n \"product\": 1,\n \"id_country\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/clients/:id/add_balance","description":"Adds a specified amount of balance to the client identified by the provided ID.
\n(Required)
\n","type":"text/plain"},"type":"any","value":"Client ID","key":"id"}]}},"response":[{"id":"f356b119-952f-4d64-b873-2934f4b89975","name":"Balance added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 28,\n \"product\": 1,\n \"id_country\": 1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://plataforma.connectus.la/api_v3/clients/:id/add_balance","host":["https://plataforma.connectus.la"],"path":["api_v3","clients",":id","add_balance"],"variable":[{"key":"id","value":"792e188d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Balance added successfully\"\r\n}"},{"id":"4d558fbf-4cff-4d0a-a2ba-d1a70f6e4131","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/clients"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8d2d6ed4-0edb-449e-a802-c7f873700a13"},{"name":"Remove balance of a client by client ID","id":"462705a0-1ebb-441e-9a4c-2f99547c8322","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 69,\n \"product\": 1,\n \"id_country\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/clients/:id/remove_balance","description":"Removes specified amount of balance to the client identified by the provided ID.
\n(Required)
\n","type":"text/plain"},"type":"any","value":"Client ID","key":"id"}]}},"response":[{"id":"badd2017-3a98-4460-845c-973205f0efc2","name":"Balance removed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"amount\": 69,\n \"product\": 1,\n \"id_country\": 1\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://plataforma.connectus.la/api_v3/clients/:id/remove_balance","host":["https://plataforma.connectus.la"],"path":["api_v3","clients",":id","remove_balance"],"variable":[{"key":"id","value":"792e188d"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"Balance removed successfully\"\r\n}"},{"id":"a726517e-8757-44b3-8390-d8252a84aa5e","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/clients"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"462705a0-1ebb-441e-9a4c-2f99547c8322"},{"name":"Create a new client","id":"0e912702-ccb8-46a0-8c32-3b3141c84a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test 100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/clients","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","clients"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[{"id":"b2e1ef52-3ac1-4db0-93ff-aaf8eb934966","name":"Client created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"test 100\"\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/clients"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 11,\r\n \"id_account\": 2311,\r\n \"name\": \"test 100\",\r\n \"balance\": 12,\r\n \"avatar\": null,\r\n \"id_unique\": \"9sd0lmn2\",\r\n \"deleted\": \"F\",\r\n \"created_at\": \"Mon, 09 Jan 2023 13:30:07.000000000 -03 -03:00\",\r\n \"updated_at\": \"Mon, 09 Jan 2023 13:30:07.000000000 -03 -03:00\"\r\n}"},{"id":"0cfd0224-772d-404a-94a5-3f60c4ead7c8","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/clients"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0e912702-ccb8-46a0-8c32-3b3141c84a96"}],"id":"0f4684e1-c93b-4b98-affb-73f33b8339ab","description":"Generate sub-clients as accounting accounts. You can assign available balance for each service so that when sending, it will be deducted from each sub-client.
\n• The SMS API must include the destination country, each balance is separated according to this value.
\n• The email and WhatsApp APIs have homogeneous costs.
\n• In case there are clients and their ID is not sent, the amount will be deducted from the unassigned balance. If there is no unassigned balance, the message will not be sent.
\n","event":[{"listen":"prerequest","script":{"id":"0e1f95de-1533-4868-a8b8-2ecc7a746be6","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"1fb923e6-4761-4626-90a1-8384cca5b838","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"0f4684e1-c93b-4b98-affb-73f33b8339ab","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Short Link","item":[{"name":"Retrieve link events","id":"ad7c9dff-e87e-47fe-8478-7141f0dc58f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://plataforma.connectus.la/api_v3/short_link/312321","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","short_link","312321"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[{"id":"8163744d-3260-4a03-8757-5a2bc124937e","name":"Retrieve link events","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"localhost:3000/api_v3/short_link/events?short_link=cnct.us/13neyY","host":["localhost"],"port":"3000","path":["api_v3","short_link","events"],"query":[{"key":"short_link","value":"cnct.us/13neyY","description":"(Required)"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"link\": \"https://www.connectus.cl\",\n \"clicks\": 3258\n}"},{"id":"80821029-113a-4825-ab77-1467049e092b","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"localhost:3000/api_v3/short_link/events?short_link=Connectus link shortener, you can manage click tracking data. To use it, you must have the option enabled, for which you need to send an email to contacto@connectus.cl
\n","_postman_id":"05c4d5d8-90c5-4005-aae1-f7bf9feb13e2","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Email","item":[{"name":"Retrieve the status from an Email by ID","id":"16545a53-dc7f-46c7-bb41-be03e1bca2c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://plataforma.connectus.la/api_v3/email/:id","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","email",":id"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"94a781fb-8bcd-4d1f-af04-e1b0ae0bf593","name":"Status retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/email/status/:id","host":["{{baseUrl}}"],"path":["email","status",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Send emails to different addresses. To use the API, you must have an assigned origin email, which can be done through the platform https://plataforma.connectus.la or by writing to contacto@connectus.cl
\nOptional parameters:
\n• id_delivery: Unique delivery ID. If this parameter is present, the email will be assigned to an already created delivery.
\n• It cannot be a delivery that has already been executed.
\n• The delivery parameter must be id_product=2.
\n• id_client: Unique ID of the sub-client to whom the email sending should be charged.
\n","_postman_id":"7e88e527-60f1-4e72-807b-a29cfa298852","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Whatsapp","item":[{"name":"send_whatsapp","id":"e900eebc-8356-4627-b686-6f769ca63fa4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"src_number\": \"56999944837\",\n \"dst_number\": \"56987688060\",\n \"whatsapp_content\": \"Test\",\n \"id_client\": \"a1476f56\",\n \"id_delivery\": \"484ed6ca9e0341799ffa4bad4a1d907c\"\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/whatsapp/send_message","description":"This API endpoint is used to send a WhatsApp message. The request should be sent via an HTTP POST method to the specified URL. The request body should include the source number, destination number, and the content of the WhatsApp message.
\nsrc_number: The source number from which the WhatsApp message will be sent.dst_number: The destination number to which the WhatsApp message will be sent.whatsapp_content: The content of the WhatsApp message.The API returns a status code of 401 for unauthorized access along with an error message in the response body.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","whatsapp","send_message"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[],"_postman_id":"e900eebc-8356-4627-b686-6f769ca63fa4"},{"name":"status","id":"a82420fd-773b-4dcf-9b67-74e6ad501584","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/whatsapp/status?message_id=0a3b773f79cf4f72842ed9818c89c523","description":"This API endpoint allows you to send a WhatsApp message.
\nmessage_id (string, required): The ID of the message to be sent.error (string): Describes the error encountered during the request.This API endpoint allows you to send a WhatsApp message.
\nmessage_id (string, required): The ID of the message to be sent.error (string): Describes the error encountered during the request.Send WhatsApp messages to different addresses. To use the API, you must have an assigned origin number; for this, write to contacto@connectus.cl.
\nOptional parameters:
\n• id_delivery: Unique delivery ID. If this parameter is present, the WhatsApp message will be assigned to an already created delivery.
\n• It cannot be a delivery that has already been executed.
\n• The delivery parameter must be id_product=3.
\n• id_client: Unique ID of the sub-client to whom the WhatsApp message sending should be charged.
\n","_postman_id":"9fe4f191-dbe9-45ea-bcae-bf0c8f1f6ad1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Account","item":[{"name":"Retrieve account info","id":"9809aff0-a7a2-447b-bf72-b74850960d15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://plataforma.connectus.la/api_v3/account","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","account"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[{"id":"22c2e80a-9abb-447e-8502-7027f6cadd9d","name":"Account retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/account/84f71863b7f64738aabc97afed7cd54d"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"id_account\": \"84f71863b7f64738aabc97afed7cd54d\",\n \"name\": \"empresa SpA\",\n \"country\": \"Chile\",\n \"phone\": 56990324203,\n \"email\": \"contacto@empresa.cl\",\n \"sms_status_hook_url\": \"https://www.empresa.cl/endpoints_sms/status\",\n \"sms_incoming_hook_url\": \"https://www.empresa.cl/endpoints_sms/status\",\n \"purchases\": [\n {\n \"status\": \"COMPLETED\",\n \"payment_method\": \"PAYPAL\",\n \"country\": \"Chile\",\n \"price\": 1621365,\n \"price_with_tax\": 2013727,\n \"datetime\": \"29-05-19 15:32:08\",\n \"currency\": \"CLP\",\n \"id_purchase\": \"9b625dac70654fb58f1250702aab4355\"\n },\n {\n \"status\": \"COMPLETED\",\n \"payment_method\": \"TRANSFER\",\n \"country\": \"Chile\",\n \"price\": 1362492,\n \"price_with_tax\": 11900,\n \"datetime\": \"23-09-19 15:01:55\",\n \"currency\": \"CLP\",\n \"id_purchase\": \"7145a64a41a3438f9362e6d02f34201c\"\n },\n {\n \"status\": \"COMPLETED\",\n \"payment_method\": \"KHIPU\",\n \"country\": \"Chile\",\n \"price\": 9613860,\n \"price_with_tax\": 11440493,\n \"datetime\": \"24-11-19 12:25:30\",\n \"currency\": \"CLP\",\n \"id_purchase\": \"f2db5749e38f425f93c6110b36e23a60\"\n }\n ],\n \"users\": [\n {\n \"name\": \"Pedro Apellido\",\n \"type\": \"ADMIN\",\n \"phone\": 56990324203,\n \"email\": \"pedro@empresa.cl\",\n \"banned\": false\n },\n {\n \"name\": \"Juan Apellido\",\n \"type\": \"USER\",\n \"phone\": null,\n \"email\": \"juan@empresa.cl\",\n \"banned\": false\n },\n {\n \"name\": \"Diego Apellido\",\n \"type\": \"USER\",\n \"phone\": null,\n \"email\": \"diego@empresa.cl\",\n \"banned\": false\n }\n ],\n \"src_numbers\": [\n {\n \"src_number\": 56442340006,\n \"is_default\": false,\n \"country\": \"Chile\"\n },\n {\n \"src_number\": 54442340601,\n \"is_default\": true,\n \"country\": \"México\"\n },\n {\n \"src_number\": 56442341000,\n \"is_default\": true,\n \"country\": \"Chile\"\n }\n ],\n \"src_emails\": [\n {\n \"src_email\": \"contacto@empresa.cl\",\n \"is_default\": true,\n \"is_verified\": true\n },\n {\n \"src_email\": \"finanzas@empresa.cl\",\n \"is_default\": false,\n \"is_verified\": true\n }\n ]\n}"},{"id":"15fd7bae-5e77-4970-b3ee-c95ebe8df574","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/account/:id","host":["{{baseUrl}}"],"path":["account",":id"],"variable":[{"key":"id","value":"Gets the information of the associated account.
\n","_postman_id":"f1e9e2a9-ea82-499b-8b31-ee264e48205b","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Delivery","item":[{"name":"Retrieve delivery info","id":"0db5ef51-9036-41cc-a488-71ed70ff2f5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://plataforma.connectus.la/api_v3/deliveries/e4a1dbb9e10a4f0abf058c42984980d4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","deliveries","e4a1dbb9e10a4f0abf058c42984980d4"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[],"_postman_id":"0db5ef51-9036-41cc-a488-71ed70ff2f5a"},{"name":"Create delivery","id":"9ad35e2b-1c13-41dc-8936-b8b297341018","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"delivery\":{\n \"name\": \"test-api-email\",\n \"deliver_at\": \"2024-07-20 12:00:00\",\n \"id_product\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/deliveries","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","deliveries"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ad35e2b-1c13-41dc-8936-b8b297341018"},{"name":"Update delivery","id":"b3ed2723-68a9-45cb-882f-d9ba52b84617","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"delivery\":{\n \"name\": \"test\",\n \"deliver_at\": \"2024-06-20 14:00:00\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://plataforma.connectus.la/api_v3/deliveries/33d0b01af7484f94ae23c24c63282053","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}},"urlObject":{"path":["api_v3","deliveries","33d0b01af7484f94ae23c24c63282053"],"host":["https://plataforma.connectus.la"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3ed2723-68a9-45cb-882f-d9ba52b84617"}],"id":"4614ee9e-5b82-473a-a2ac-3cae398bd86a","description":"Generate a delivery. This can be scheduled for any time in the future. The id_product parameter defines the type of product for which the delivery is created.
\n1: SMS
\n2: WhatsApp
\n3: Email
\nIt returns an ID which can be used in the SMS, Email, and WhatsApp endpoints.
\n","_postman_id":"4614ee9e-5b82-473a-a2ac-3cae398bd86a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{api_user}}"},{"key":"password","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"8a430d36-6278-4665-be24-a114b3a7a698","id":"8a430d36-6278-4665-be24-a114b3a7a698","name":"Connectus API Service","type":"collection"}}},{"name":"Whatsapp QR","item":[{"name":"Auth","item":[{"name":"Obtener QR","id":"47ef3e9c-dc46-46d4-b62e-697874d24be2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token_whatsappqr}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://whatsappqr.connectus.la/qr","urlObject":{"protocol":"https","path":["qr"],"host":["whatsappqr","connectus","la"],"query":[],"variable":[]}},"response":[],"_postman_id":"47ef3e9c-dc46-46d4-b62e-697874d24be2"},{"name":"Ver el estado de autenticación del usuario","id":"ac7244bb-b812-418d-b527-0102348d6914","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token_whatsappqr}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://whatsappqr.connectus.la/status","urlObject":{"protocol":"https","path":["status"],"host":["whatsappqr","connectus","la"],"query":[],"variable":[]}},"response":[],"_postman_id":"ac7244bb-b812-418d-b527-0102348d6914"}],"id":"d84fe642-5a35-4daf-a2f4-96a8d62c53e0","description":"The /me endpoints let you manage information about the authenticated user.