Initial commit for SendSMS Swagger configuration (#3496)
* Initial commit for SendSMS Swagger configuration * SendSMS update apiProperties.json
This commit is contained in:
Mainerici Elena
GitHub
Родитель
3c51717b48
Коммит
8d4ce7716b
|
|
@ -0,0 +1,348 @@
|
|||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "SendSMS",
|
||||
"description": "sendSMS is a leading European Communications Platform as a Service (CPaaS) known for its reliability. Established in 2008, the platform has expanded its services globally. Specializing in seamless no-code and low-code integrations, sendSMS has effectively integrated with over 30 eCommerce platforms, CRMs, ERPs, and various integrators, streamlining communications and operational efficiency.",
|
||||
"version": "1.0",
|
||||
"contact": {
|
||||
"name": "sendSms",
|
||||
"url": "https://www.sendsms.ro",
|
||||
"email": "support@sendsms.ro"
|
||||
}
|
||||
},
|
||||
"host": "api.sendsms.ro",
|
||||
"basePath": "/integration/powerautomate/",
|
||||
"schemes": ["https"],
|
||||
"consumes": ["application/json"],
|
||||
"produces": ["application/json"],
|
||||
"paths": {
|
||||
"/message_send": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Message sent successfully",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Status code"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Status message"
|
||||
},
|
||||
"message_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the message"
|
||||
},
|
||||
"details": {
|
||||
"type": "string",
|
||||
"description": "Additional details"
|
||||
},
|
||||
"mcc": {
|
||||
"type": "string",
|
||||
"description": "Mobile country code"
|
||||
},
|
||||
"mnc": {
|
||||
"type": "string",
|
||||
"description": "Mobile network code"
|
||||
},
|
||||
"parts": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Parts"
|
||||
},
|
||||
"length": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Length of the OTP; max length is 10"
|
||||
},
|
||||
"shortlink": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"description": "shortlink"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request - Required parameter missing or invalid",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Error message"
|
||||
},
|
||||
"details": {
|
||||
"type": "string",
|
||||
"description": "Detailed error message"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Unauthorized - Authentication failed",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Error message indicating authentication failure"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"to": {
|
||||
"type": "string",
|
||||
"description": "Recipient phone number",
|
||||
"title": "To",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"text": {
|
||||
"type": "string",
|
||||
"description": "Text of the message",
|
||||
"title": "Text",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"from": {
|
||||
"type": "string",
|
||||
"description": "Sender",
|
||||
"title": "Sender (From)",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"short": {
|
||||
"type": "string",
|
||||
"description": "Shortened URL"
|
||||
}
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"operationId": "message_send",
|
||||
"summary": "Message Send",
|
||||
"x-ms-visibility": "important",
|
||||
"description": "This method is designed to activate the process of sending a Short Message Service (SMS) message to a pre-determined phone number upon receiving a specific request. It seamlessly facilitates the communication by ensuring that the SMS is transmitted efficiently to the designated recipient.",
|
||||
"x-ms-openai-data": {
|
||||
"openai-enabled": true,
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "message_send",
|
||||
"x-ms-require-user-confirmation": true
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"/message_status": {
|
||||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Message status retrieved successfully",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Status code of the message"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Status message"
|
||||
},
|
||||
"details": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Status of the message"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Message"
|
||||
},
|
||||
"cost": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"description": "Cost"
|
||||
},
|
||||
"parts": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Parts"
|
||||
},
|
||||
"timestamp_created": {
|
||||
"type": "string",
|
||||
"description": "Timestamp when the message was created"
|
||||
},
|
||||
"timestamp_delivered": {
|
||||
"type": "string",
|
||||
"description": "Timestamp when the message was delivered"
|
||||
},
|
||||
"timestamp_failed": {
|
||||
"type": "string",
|
||||
"description": "Timestamp when the message failed"
|
||||
},
|
||||
"failover_id": {
|
||||
"type": "string",
|
||||
"description": "Failover Id"
|
||||
},
|
||||
"ctype": {
|
||||
"type": "string",
|
||||
"description": "1 = SMS (Default), 2 = RCS - (not active yet), 3 = Viber (failover to SMS if undelivered)"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Bad Request - Required parameter missing",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Error message for missing parameter"
|
||||
},
|
||||
"details": {
|
||||
"type": "string",
|
||||
"description": "Details of the missing parameter"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "Not Found - Message does not exist",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Error message indicating the message does not exist"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Message Status",
|
||||
"description": "The Message Status method is designed to retrieve the current status of a message that has been sent through a communication platform. This method plays a critical role in message delivery systems, offering developers and users insights into the message lifecycle, including whether a message has been sent, delivered or encountered any errors during the process.",
|
||||
"x-ms-visibility": "important",
|
||||
"operationId": "message_status",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"message_id": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier for the message to retrieve status",
|
||||
"title": "Message ID",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"x-ms-openai-data": {
|
||||
"openai-enabled": true,
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "message_status",
|
||||
"x-ms-require-user-confirmation": true
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {},
|
||||
"parameters": {},
|
||||
"responses": {},
|
||||
"securityDefinitions": {
|
||||
"oauth2-auth": {
|
||||
"type": "oauth2",
|
||||
"flow": "accessCode",
|
||||
"authorizationUrl": "https://api.sendsms.ro/oauth2/authorize",
|
||||
"tokenUrl": "https://api.sendsms.ro/oauth2/token",
|
||||
"scopes": {
|
||||
"PowerAutomate": "PowerAutomate"
|
||||
}
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"oauth2-auth": [
|
||||
"PowerAutomate"
|
||||
]
|
||||
}
|
||||
],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://www.sendsms.ro/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://www.sendsms.ro/en/gdpr/"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Communication;Marketing"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
{
|
||||
"properties": {
|
||||
"connectionParameters": {
|
||||
"token": {
|
||||
"type": "oauthSetting",
|
||||
"oAuthSettings": {
|
||||
"identityProvider": "oauth2",
|
||||
"clientId": "Value-From-Your-App-Registration",
|
||||
"clientSecret": "Value-From-Your-App-Registration",
|
||||
"scopes": ["PowerAutomate"],
|
||||
"redirectMode": "Global",
|
||||
"redirectUrl": "https://global.consent.azure-apim.net/redirect",
|
||||
"properties": {
|
||||
"IsFirstParty": "False"
|
||||
},
|
||||
"customParameters": {
|
||||
"AuthorizationUrl": {
|
||||
"value": "https://api.sendsms.ro/oauth2/authorize"
|
||||
},
|
||||
"TokenUrl": {
|
||||
"value": "https://api.sendsms.ro/oauth2/token"
|
||||
},
|
||||
"RefreshUrl": {
|
||||
"value": "https://api.sendsms.ro/oauth2/refresh_token"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#3D82B0",
|
||||
"capabilities": ["actions"],
|
||||
"publisher": "sendSMS",
|
||||
"stackOwner": "sendSMS"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
# sendSMS Connector
|
||||
The sendSMS connector integrates with the sendSMS platform, a leading European Communications Platform as a Service (CPaaS) known for its reliability and expansive reach. Established in 2008, sendSMS has specialized in providing seamless no-code and low-code integrations with over 30 eCommerce platforms, CRMs, ERPs, and various other integrators, enhancing communication and operational efficiency across the globe.
|
||||
|
||||
## Publisher: sendSMS
|
||||
sendSMS is a premier provider in the CPaaS market, delivering trusted and effective communication solutions since 2008. The platform supports a wide range of integrations, making it an ideal choice for businesses looking to streamline their communication processes.
|
||||
|
||||
## Prerequisites
|
||||
A contract with sendSMS is required to access the services provided by this connector.
|
||||
|
||||
## Supported Operations
|
||||
The connector supports the following operations, making communication management smoother and more reliable:
|
||||
### message_send
|
||||
This method activates the process of sending an SMS message to a pre-determined phone number upon receiving a specific request. It ensures efficient transmission of messages to the intended recipient.
|
||||
### message_status
|
||||
The Message Status method retrieves the current status of an SMS that has been sent, providing insights into the message lifecycle, including delivery statuses and any errors that may have occurred during transmission.
|
||||
|
||||
## Obtaining Credentials
|
||||
Authentication for this connector uses OAuth 2.0 with a key refresh mechanism. Here are the steps to obtain initial credentials:
|
||||
- **Contract Signing**: Engage with our sales or business development team to finalize the terms of service.
|
||||
- **Account Setup**: Once the contract is signed, we will set up your organizational account.
|
||||
- **Credential Issuance**: Initial credentials, including the client ID and client secret, will be provided. These are essential for accessing our services and must be stored securely.
|
||||
|
||||
## Authentication Method
|
||||
Our system employs OAuth 2.0 for authentication, ensuring secure interactions through token-based permissions:
|
||||
- **Key Refresh Mechanism**: To maintain security, our OAuth 2.0 setup includes a key refresh mechanism, allowing periodic refresh of access tokens using provided refresh tokens without re-authentication.
|
||||
|
||||
## Usage Notes
|
||||
- Use the client ID and client secret to request an access token from the OAuth 2.0 token endpoint.
|
||||
- Include the access token in the HTTP Authorization header to authenticate API requests.
|
||||
- Use the refresh token to obtain new access tokens when necessary, as per our key refresh mechanism.
|
||||
|
||||
## Known Issues and Limitations
|
||||
No known issues or limitations at this time. Please contact support if you encounter any problems using the connector.
|
||||
|
||||
## Deployment Instructions
|
||||
To deploy this connector as a custom connector in Power Automate or Power Apps:
|
||||
1. Download the connector definition from the provided GitHub repository.
|
||||
2. Navigate to Power Automate or Power Apps and select 'Custom Connectors' from the Data section.
|
||||
3. Click 'Import an OpenAPI file', and upload the connector definition file.
|
||||
4. Fill out the necessary information and update the connector's security settings accordingly.
|
||||
5. Create a new connection using the initial credentials provided during the account setup phase.
|
||||
|
||||
These instructions should help users effectively integrate the sendSMS connector into their workflows, enhancing their communication capabilities.
|
||||
Загрузка…
Ссылка в новой задаче