masstack

V2
API Overview Resources Schemas

Communications

Communications Fixed Phone Number Validation defines the endpoint to validate if a fixed phone number is correct

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
destinationEmail query string true Queried communication’s email destination address
terminatingNumber query integer(int64) true Queried communication’s SMS terminating number without country code
countryCode query integer(int64) false Queried communication’s SMS country code without + symbol
requestTime[gt] query string false Return requests with request time greater (later) than the one specified
requestTime[lt] query string false Return requests with request time lower (earlier) than the one specified
clientId query string false Queried communication’s client id taken from audience header
limit query integer(int64) false Limit of results in the response
offset query integer(int64) false Offset applied to results for pagination
externalId query string true Internal reference provided by the client system that could be used in later queries

Request example

1
2
3
4
5


curl -X GET https://communications.masstack.com/v2/orgs/yoigo/communications?destinationEmail='diego.mateos@masmovil.com'&terminatingNumber='666123123'&countryCode='34'&requestTime[gt]='2020-01-01T14:00:00+01:00'&requestTime[lt]='2020-12-01T14:00:00+01:00'&clientId='mysim-sa'&limit='20'&offset='0'&externalId='sale-12512321'?destinationEmail=diego.mateos%40masmovil.com&terminatingNumber=666123123&externalId=sale-12512321 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Successful communications search CommunicationListResponse
400 Bad Request Client error on request ResponseErrorDto
500 Internal Server Error Server error ResponseErrorDto

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
body body CommunicationRequestDto true Information needed to send a communication

Request body - instance of CommunicationRequestDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

{
  "type": "password_reset",
  "language": "en",
  "channels": "[sms]",
  "scheduledTime": "2022-04-25T12:00:00",
  "smsInput": {
    "countryCode": "54",
    "terminatingNumber": "623196241"
  },
  "emailInput": {
    "destinationEmail": "recipient@masmovil.es",
    "destinationName": "Diego"
  },
  "whatsAppInput": {
    "terminatingNumber": "623196241"
  },
  "externalId": "string",
  "arguments": {
    "name": "Juan",
    "subscriptions": [
      "ftth",
      "mobile",
      "health"
    ],
    "resetLink": "https://password.com/reset/123456",
    "birthDate": "2022-04-25 12:00:00",
    "vipClient": false,
    "balance": 45.7,
    "birthCountry": "US",
    "attached.txt": "SG9sYSBQYWJsbyA6KQo=",
    "embedded_image_png": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "qrArgument": "Text to convert into QR Code",
    "pdfAttachments": {
      "apple.pdf": "VGhpcyBpcyBhIFBERiBjb250ZW50",
      "pear.pdf": "VGhpcyBpcyBhIFBERiBjb250ZW50"
    }
  }
}
Name Type Required Description
type string true Communication type code according to the ones previously defined in the system
language string true Communication language(ISO 639-1)
channels [string] false Channels list through which the communication will be sent, allowed values are: “sms”, “email”. If not specified, all channels with a defined template are used
scheduledTime string false Programmed time for the communication to be sent that can be reprogrammed to fit delivery window.
smsInput CommunicationRequestSmsDto false Specific parameters needed for SMS channel, mandatory if SMS channel requested. No need to provide it when previewing a communication
emailInput CommunicationRequestEmailDto false Specific parameters needed for email channel, mandatory if email channel requested. No need to provide it when previewing a communication
whatsAppInput CommunicationRequestWhatsAppDto false Specific parameters needed for whatsApp channel, mandatory if whatsApp channel requested. No need to provide it when previewing a communication
externalId string false Client internal reference
arguments object false Parameters and assigned values that are required to render the specified template. Depending on the argument type they can be a string, a number, a boolean or an array
» additionalProperties object false Parameters and assigned values that are required to render the specified template. Depending on the argument type they can be a string, a number, a boolean or an array

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44


curl -X POST https://communications.masstack.com/v2/orgs/yoigo/communications \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'type': 'password_reset',
  'language': 'en',
  'channels': '[sms]',
  'scheduledTime': '2022-04-25T12:00:00',
  'smsInput': {
    'countryCode': '54',
    'terminatingNumber': '623196241'
  },
  'emailInput': {
    'destinationEmail': 'recipient@masmovil.es',
    'destinationName': 'Diego'
  },
  'whatsAppInput': {
    'terminatingNumber': '623196241'
  },
  'externalId': 'string',
  'arguments': {
    'name': 'Juan',
    'subscriptions': [
      'ftth',
      'mobile',
      'health'
    ],
    'resetLink': 'https://password.com/reset/123456',
    'birthDate': '2022-04-25 12:00:00',
    'vipClient': false,
    'balance': 45.7,
    'birthCountry': 'US',
    'attached.txt': 'SG9sYSBQYWJsbyA6KQo=',
    'embedded_image_png': 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==',
    'qrArgument': 'Text to convert into QR Code',
    'pdfAttachments': {
      'apple.pdf': 'VGhpcyBpcyBhIFBERiBjb250ZW50',
      'pear.pdf': 'VGhpcyBpcyBhIFBERiBjb250ZW50'
    }
  }
}"

Responses

Code Meaning Description Schema
202 Accepted Successfully sent communication CommunicationResponse
206 Partial Content Communication sent with with some kind of failure, e.g:the e-mail and whatsapp have been successfully sent but the SMS failed in a multi-channel communication CommunicationResponse
400 Bad Request The response for client error when some field in the request is missing or invalid ResponseErrorDto
500 Internal Server Error Server error ResponseErrorDto

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
communicationId path string true The communication identifier

Request example

1
2
3
4
5


curl -X GET https://communications.masstack.com/v2/orgs/yoigo/communications/57cff118-984f-473c-a6ad-5ba51baed0dd/attachments \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Successfully found attachments CommunicationAttachmentResponse
404 Not Found Communication not found ResponseErrorDto
500 Internal Server Error Server error ResponseErrorDto

Parameters

Name In Type Required Description
qrToken query string true The communication encrypted data for generating QR Image

Request example

1
2
3
4
5


curl -X GET https://communications.masstack.com/v2/qr?qrToken='bqzmxvphwrtgdycsolna'?qrToken=bqzmxvphwrtgdycsolna \
  -H "Accept: image/png" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Successfully created QR code image None
400 Bad Request Invalid, missing or expired QR token ResponseErrorDto
500 Internal Server Error Server error while retrieving image ResponseErrorDto

400 - instance of ResponseErrorDto

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "errors": [
    {
      "code": "COMMS_001",
      "title": "COMMUNICATIONS_X_X_X",
      "details": "[COMMUNICATIONS] Bad request: QR code expired or malformed",
      "ref": "https://developers.masstack.com/en/docs/apis_communications_doc_swagger/2/schemas"
    }
  ]
}
Name Type Required Description
errors [ErrorDto] false Error info

500 - instance of ResponseErrorDto

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "errors": [
    {
      "code": "COMMS_006",
      "title": "COMMUNICATIONS_X_X_X",
      "details": "[COMMUNICATIONS] Internal Server Error: Error retrieving image",
      "ref": "https://developers.masstack.com/en/docs/apis_communications_doc_swagger/2/schemas"
    }
  ]
}
Name Type Required Description
errors [ErrorDto] false Error info

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
communicationId path string true The communication identifier

Request example

1
2
3
4
5


curl -X GET https://communications.masstack.com/v2/orgs/yoigo/communications/57cff118-984f-473c-a6ad-5ba51baed0dd \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Successfully found communication CommunicationResponse
404 Not Found Sent communication not found ResponseErrorDto
500 Internal Server Error Server error ResponseErrorDto

Parameters

Name In Type Required Description
body body FixedPhoneNumberValidationRequestDto true Phone number to validate

Request body - instance of FixedPhoneNumberValidationRequestDto

1
2
3
4

{
  "phoneNumber": "612345678",
  "countryCode": "ES"
}
Name Type Required Description
phoneNumber string true Phone number to validate
countryCode string false Country code in ISO 3166-1 alpha-2 format

Request example

1
2
3
4
5
6
7
8
9


curl -X POST https://communications.masstack.com/v2/validate/fixed \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '612345678',
  'countryCode': 'ES'
}"

Responses

Code Meaning Description Schema
200 OK OK FixedPhoneNumberValidationResponseDto
400 Bad Request Bad Request ResponseErrorDto

Parameters

Name In Type Required Description
body body MobilePhoneNumberValidationRequestDto true Phone number to validate

Request body - instance of MobilePhoneNumberValidationRequestDto

1
2
3
4

{
  "phoneNumber": "612345678",
  "countryCode": "ES"
}
Name Type Required Description
phoneNumber string true Phone number to validate
countryCode string false Country code in ISO 3166-1 alpha-2 format

Request example

1
2
3
4
5
6
7
8
9


curl -X POST https://communications.masstack.com/v2/validate/mobile \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'phoneNumber': '612345678',
  'countryCode': 'ES'
}"

Responses

Code Meaning Description Schema
200 OK OK MobilePhoneNumberValidationResponseDto
400 Bad Request Bad Request ResponseErrorDto

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
body body CommunicationRequestDto true Information needed to preview a communication

Request body - instance of CommunicationRequestDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

{
  "type": "password_reset",
  "language": "en",
  "channels": "[sms]",
  "scheduledTime": "2022-04-25T12:00:00",
  "smsInput": {
    "countryCode": "54",
    "terminatingNumber": "623196241"
  },
  "emailInput": {
    "destinationEmail": "recipient@masmovil.es",
    "destinationName": "Diego"
  },
  "whatsAppInput": {
    "terminatingNumber": "623196241"
  },
  "externalId": "string",
  "arguments": {
    "name": "Juan",
    "subscriptions": [
      "ftth",
      "mobile",
      "health"
    ],
    "resetLink": "https://password.com/reset/123456",
    "birthDate": "2022-04-25 12:00:00",
    "vipClient": false,
    "balance": 45.7,
    "birthCountry": "US",
    "attached.txt": "SG9sYSBQYWJsbyA6KQo=",
    "embedded_image_png": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "qrArgument": "Text to convert into QR Code",
    "pdfAttachments": {
      "apple.pdf": "VGhpcyBpcyBhIFBERiBjb250ZW50",
      "pear.pdf": "VGhpcyBpcyBhIFBERiBjb250ZW50"
    }
  }
}
Name Type Required Description
type string true Communication type code according to the ones previously defined in the system
language string true Communication language(ISO 639-1)
channels [string] false Channels list through which the communication will be sent, allowed values are: “sms”, “email”. If not specified, all channels with a defined template are used
scheduledTime string false Programmed time for the communication to be sent that can be reprogrammed to fit delivery window.
smsInput CommunicationRequestSmsDto false Specific parameters needed for SMS channel, mandatory if SMS channel requested. No need to provide it when previewing a communication
emailInput CommunicationRequestEmailDto false Specific parameters needed for email channel, mandatory if email channel requested. No need to provide it when previewing a communication
whatsAppInput CommunicationRequestWhatsAppDto false Specific parameters needed for whatsApp channel, mandatory if whatsApp channel requested. No need to provide it when previewing a communication
externalId string false Client internal reference
arguments object false Parameters and assigned values that are required to render the specified template. Depending on the argument type they can be a string, a number, a boolean or an array
» additionalProperties object false Parameters and assigned values that are required to render the specified template. Depending on the argument type they can be a string, a number, a boolean or an array

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44


curl -X POST https://communications.masstack.com/v2/orgs/yoigo/communications/preview \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'type': 'password_reset',
  'language': 'en',
  'channels': '[sms]',
  'scheduledTime': '2022-04-25T12:00:00',
  'smsInput': {
    'countryCode': '54',
    'terminatingNumber': '623196241'
  },
  'emailInput': {
    'destinationEmail': 'recipient@masmovil.es',
    'destinationName': 'Diego'
  },
  'whatsAppInput': {
    'terminatingNumber': '623196241'
  },
  'externalId': 'string',
  'arguments': {
    'name': 'Juan',
    'subscriptions': [
      'ftth',
      'mobile',
      'health'
    ],
    'resetLink': 'https://password.com/reset/123456',
    'birthDate': '2022-04-25 12:00:00',
    'vipClient': false,
    'balance': 45.7,
    'birthCountry': 'US',
    'attached.txt': 'SG9sYSBQYWJsbyA6KQo=',
    'embedded_image_png': 'iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==',
    'qrArgument': 'Text to convert into QR Code',
    'pdfAttachments': {
      'apple.pdf': 'VGhpcyBpcyBhIFBERiBjb250ZW50',
      'pear.pdf': 'VGhpcyBpcyBhIFBERiBjb250ZW50'
    }
  }
}"

Responses

Code Meaning Description Schema
200 OK Communication previewed successfully CommunicationPreviewResponse
206 Partial Content The request could be successfully processed but some alteration in the process CommunicationPreviewResponse
400 Bad Request The response for client error when some field in the request is missing or invalid ResponseErrorDto
500 Internal Server Error Server error ResponseErrorDto

Endpoints

CMS

    Communications

      Short URLs

        Communication Types

          Examples

            Templates