Update (#492)
This commit is contained in:
SerwerSMS.pl
GitHub
Родитель
eb16d89d55
Коммит
eb274f8729
|
|
@ -0,0 +1,484 @@
|
|||
{
|
||||
"basePath": "/",
|
||||
"consumes": [],
|
||||
"definitions": {},
|
||||
"host": "flow.serwersms.pl",
|
||||
"info": {
|
||||
"contact": {
|
||||
"name": "SerwerSMS",
|
||||
"url": "https://serwersms.pl",
|
||||
"email": "bok@serwersms.pl"
|
||||
},
|
||||
"description": "SerwerSMS allows sending and receiving SMS messages. Our platform has the function of both single and mass SMS sending. Sending messages has never been so easy, fast and effective.",
|
||||
"title": "SerwerSMS",
|
||||
"version": "2.0"
|
||||
},
|
||||
"parameters": {},
|
||||
"paths": {
|
||||
"/action/add_blacklist": {
|
||||
"post": {
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"description": "This operation add phone number to blacklist",
|
||||
"operationId": "add_blacklist",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"phone": {
|
||||
"description": "Specify the phone number you want to add to the blacklist",
|
||||
"title": "Phone number",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"phone"
|
||||
],
|
||||
"type": "object",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response for action add_blacklist",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "id",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"success": {
|
||||
"description": "success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Add to blacklist",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"/action/add_contact": {
|
||||
"post": {
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"description": "This operation add contact to customer account",
|
||||
"operationId": "add_contact",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"address": {
|
||||
"description": "Specify the address of contact",
|
||||
"title": "Address",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"city": {
|
||||
"description": "Specify the city of contact",
|
||||
"title": "City",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"company": {
|
||||
"description": "Specify the company of contact",
|
||||
"title": "Company",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"description": {
|
||||
"description": "Specify the description of contact",
|
||||
"title": "Description",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"email": {
|
||||
"description": "Specify the email of contact",
|
||||
"title": "Email",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"first_name": {
|
||||
"description": "Specify the first name of contact",
|
||||
"title": "First name",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"group_id": {
|
||||
"description": "Specify the group name of contact",
|
||||
"title": "Group name",
|
||||
"type": "string",
|
||||
"x-ms-dynamic-values": {
|
||||
"operationId": "get_group",
|
||||
"value-path": "id",
|
||||
"value-title": "title"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"last_name": {
|
||||
"description": "Specify the last name of contact",
|
||||
"title": "Last name",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"phone": {
|
||||
"description": "Specify the phone number of contact",
|
||||
"title": "Phone number",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"tax_id": {
|
||||
"description": "Specify the VAT number of contact",
|
||||
"title": "VAT number",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"phone"
|
||||
],
|
||||
"type": "object",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response for action add_contact",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "id",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"success": {
|
||||
"description": "success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Add a new contact",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"/action/get_group": {
|
||||
"get": {
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"description": "This operation retrieves contact groups",
|
||||
"operationId": "get_group",
|
||||
"parameters": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response for action get_group",
|
||||
"schema": {
|
||||
"items": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "id",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"title": {
|
||||
"description": "title",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Get groups",
|
||||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"/action/get_sender": {
|
||||
"get": {
|
||||
"description": "This operation retrieves sender's name which can be used for sending SMS",
|
||||
"operationId": "get_sender",
|
||||
"parameters": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response for action get_sender",
|
||||
"schema": {
|
||||
"items": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"description": "id",
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"description": "title",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Get senders",
|
||||
"x-ms-visibility": "internal"
|
||||
}
|
||||
},
|
||||
"/action/send_sms": {
|
||||
"post": {
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"description": "This operation send SMS messages",
|
||||
"operationId": "send_sms",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"group_id": {
|
||||
"description": "Specify the name of the group of recipients",
|
||||
"title": "Group name",
|
||||
"type": "string",
|
||||
"x-ms-dynamic-values": {
|
||||
"operationId": "get_group",
|
||||
"value-path": "id",
|
||||
"value-title": "title"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"message": {
|
||||
"description": "Specify the message of the SMS",
|
||||
"title": "Message",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"phone": {
|
||||
"description": "Specify the recipient's phone number",
|
||||
"title": "Phone number",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"sender": {
|
||||
"description": "Specify the sender name (only for FULL SMS)",
|
||||
"title": "Sender name",
|
||||
"type": "string",
|
||||
"x-ms-dynamic-values": {
|
||||
"operationId": "get_sender",
|
||||
"value-path": "title",
|
||||
"value-title": "title"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"utf": {
|
||||
"description": "Select the option to enable sending special characters like cyrylica etc.",
|
||||
"enum": [
|
||||
false,
|
||||
true
|
||||
],
|
||||
"title": "UCS2 encoding",
|
||||
"type": "boolean",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"message"
|
||||
],
|
||||
"type": "object",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response for action send_sms",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"queued": {
|
||||
"description": "queued",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"success": {
|
||||
"description": "success",
|
||||
"type": "boolean"
|
||||
},
|
||||
"unsent": {
|
||||
"description": "unsent",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Send SMS message",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"/action=get_group": {},
|
||||
"/blacklist/add": {},
|
||||
"/contacts/add": {},
|
||||
"/index.php": {},
|
||||
"/manage/environments/Default-ae6c6278-a863-4b44-9eaa-101d36b02ef2/": {},
|
||||
"/messages/send_sms": {},
|
||||
"/senders/index": {},
|
||||
"/trigger/get_answer": {
|
||||
"post": {
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"description": "This operation triggers when a new message is received",
|
||||
"operationId": "new_answer",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"type": {
|
||||
"default": "NDI",
|
||||
"description": "Specify the type of message received",
|
||||
"enum": [
|
||||
"ECO",
|
||||
"ND",
|
||||
"NDI",
|
||||
"MMS",
|
||||
"2WAY"
|
||||
],
|
||||
"title": "Type of message",
|
||||
"type": "string",
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"type": "object",
|
||||
"x-ms-visibility": "important"
|
||||
},
|
||||
"x-ms-visibility": "important"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Response for trigger get_answer",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"items": {
|
||||
"description": "items",
|
||||
"items": {
|
||||
"properties": {
|
||||
"blacklist": {
|
||||
"description": "blacklist",
|
||||
"type": "boolean"
|
||||
},
|
||||
"id": {
|
||||
"description": "id",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"message_id": {
|
||||
"description": "message_id",
|
||||
"type": "string"
|
||||
},
|
||||
"phone": {
|
||||
"description": "phone",
|
||||
"type": "string"
|
||||
},
|
||||
"recived": {
|
||||
"description": "recived",
|
||||
"type": "string"
|
||||
},
|
||||
"text": {
|
||||
"description": "text",
|
||||
"type": "string"
|
||||
},
|
||||
"type": {
|
||||
"description": "type",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "When new SMS message is received",
|
||||
"x-ms-trigger": "batch",
|
||||
"x-ms-trigger-metadata": {
|
||||
"kind": "query",
|
||||
"mode": "polling"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"produces": [],
|
||||
"responses": {},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"security": [
|
||||
{
|
||||
"oauth2_auth": [
|
||||
"basic"
|
||||
]
|
||||
}
|
||||
],
|
||||
"securityDefinitions": {
|
||||
"oauth2_auth": {
|
||||
"authorizationUrl": "https://api2s2.serwersms.pl/oauth2/authorize",
|
||||
"flow": "accessCode",
|
||||
"scopes": {
|
||||
"basic": "basic"
|
||||
},
|
||||
"tokenUrl": "https://api2s2.serwersms.pl/oauth2/access_token",
|
||||
"type": "oauth2"
|
||||
}
|
||||
},
|
||||
"swagger": "2.0",
|
||||
"tags": [],
|
||||
"x-ms-connector-metadata": [
|
||||
{
|
||||
"propertyName": "Website",
|
||||
"propertyValue": "https://serwersms.pl"
|
||||
},
|
||||
{
|
||||
"propertyName": "Privacy policy",
|
||||
"propertyValue": "https://serwersms.pl/dokumenty/8-polityka_prywatnosci"
|
||||
},
|
||||
{
|
||||
"propertyName": "Categories",
|
||||
"propertyValue": "Marketing"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
{
|
||||
"properties": {
|
||||
"publisher": "SerwerSMS",
|
||||
"stackOwner": "SerwerSMS",
|
||||
"capabilities": [],
|
||||
"connectionParameters": {
|
||||
"token": {
|
||||
"oAuthSettings": {
|
||||
"clientId": "CLIENTID",
|
||||
"customParameters": {
|
||||
"authorizationUrl": {
|
||||
"value": "https://api2s2.serwersms.pl/oauth2/authorize"
|
||||
},
|
||||
"refreshUrl": {
|
||||
"value": "https://api2s2.serwersms.pl/oauth2/refresh_token"
|
||||
},
|
||||
"tokenUrl": {
|
||||
"value": "https://api2s2.serwersms.pl/oauth2/access_token"
|
||||
}
|
||||
},
|
||||
"identityProvider": "oauth2",
|
||||
"properties": {
|
||||
"IsFirstParty": "False"
|
||||
},
|
||||
"redirectMode": "Global",
|
||||
"redirectUrl": "https://global.consent.azure-apim.net/redirect",
|
||||
"scopes": [
|
||||
"basic"
|
||||
]
|
||||
},
|
||||
"type": "oauthSetting"
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#DE2228"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
SerwerSMS allows sending and receiving SMS messages. Our platform has the function of both single and mass SMS sending.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To use the connector, you need to create an account at https://serwersms.pl and make a prepaid payment or sign a contract. Authorization is made on the basis of a login and password.
|
||||
|
||||
## How to get credentials?
|
||||
|
||||
Authorization takes place by entering the login and password established during registration. Registration is available at https://serwersms.pl
|
||||
Загрузка…
Ссылка в новой задаче