API Overview Resources Schemas

Schemas

ManagedFolderResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "id": "id",
    "name": "example_dir/",
    "bucket": "test-bucket",
    "metadata": {
      "user": "John_doe@example.com"
    },
    "createdTime": "2024-08-01T10:38:45.698148Z",
    "updatedTime": "2024-08-01T10:38:45.698148Z"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	ManagedFolderResponseDto	false	Data content

ManagedFolderResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "id": "id",
  "name": "example_dir/",
  "bucket": "test-bucket",
  "metadata": {
    "user": "John_doe@example.com"
  },
  "createdTime": "2024-08-01T10:38:45.698148Z",
  "updatedTime": "2024-08-01T10:38:45.698148Z"
}

Name	Type	Required	Description
id	string	true	GCS folder id
name	string	true	Name of folder
bucket	string	true	Name of the bucket
metadata	object	false	Metadata associated with the resource
» additionalProperties	string	false	Metadata associated with the resource
createdTime	string(date-time)	true	Creation date and time
updatedTime	string(date-time)	true	Update date and time

ErrorDto

1
2
3


{
  "message": "String info error message"
}

Name	Type	Required	Description
message	string	false	Error message

ResponseErrorDto

1
2
3
4
5
6


{
  "commit": "v2.10.1",
  "error": {
    "message": "String info error message"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
error	ErrorDto	false	Error info

ObjectResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "id": "123456789",
    "selfLink": "https://storage.googleapis.com/bucket_name/resource_name",
    "bucket": "my_bucket",
    "name": "example.png",
    "size": "1024",
    "createdTime": "2023-06-13T12:00:00Z",
    "updatedTime": "2023-06-14T12:00:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "mediaLink": "https://storage.googleapis.com/download/bucket_name/resource_name",
    "contentType": "image/png"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	ResourceObjectResponseDto	false	Data content

ResourceObjectResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15


{
  "id": "123456789",
  "selfLink": "https://storage.googleapis.com/bucket_name/resource_name",
  "bucket": "my_bucket",
  "name": "example.png",
  "size": "1024",
  "createdTime": "2023-06-13T12:00:00Z",
  "updatedTime": "2023-06-14T12:00:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "mediaLink": "https://storage.googleapis.com/download/bucket_name/resource_name",
  "contentType": "image/png"
}

Name	Type	Required	Description
id	string	false	Unique identifier of the resource
selfLink	string	false	Link to the resource
bucket	string	false	Name of the bucket containing the resource
name	string	false	Name of the resource
size	string	false	Size of the resource in bytes
createdTime	string	false	Time the resource was created
updatedTime	string	false	Time the resource was last updated
metadata	object	false	Metadata associated with the resource
» additionalProperties	string	false	Metadata associated with the resource
mediaLink	string	false	Media link to access the resource content
contentType	string	false	Content type of the resource

CmsContentTreeResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "name": "test-bucket",
  "creationDate": "2019-08-24T14:15:22Z",
  "items": [
    {
      "name": "exampleItem",
      "publicUrl": "http://example.com/item",
      "size": "2 KB",
      "type": "image/png",
      "creationDate": "2024-09-16T00:00:00Z",
      "updatedDate": "2024-09-17T00:00:00Z",
      "metadata": "user123"
    }
  ],
  "size": "1024"
}

Name	Type	Required	Description
name	string	true	Name of the bucket
creationDate	string(date-time)	false	Creation date of the bucket
items	[CmsItemDto]	false	none
size	string	false	Size of the resource in bytes

CmsItemDto

1
2
3
4
5
6
7
8
9


{
  "name": "exampleItem",
  "publicUrl": "http://example.com/item",
  "size": "2 KB",
  "type": "image/png",
  "creationDate": "2024-09-16T00:00:00Z",
  "updatedDate": "2024-09-17T00:00:00Z",
  "metadata": "user123"
}

Name	Type	Required	Description
name	string	false	The name of the item.
publicUrl	string	false	The public URL of the item.
size	string	false	The size of the item in bytes.
type	string	false	The type of the item.
creationDate	string	false	The creation date of the item.
updatedDate	string	false	The last updated date of the item.
metadata	object	false	The user who created or last updated the item.
» additionalProperties	string	false	The user who created or last updated the item.

ContentTreeResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "name": "test-bucket",
    "creationDate": "2019-08-24T14:15:22Z",
    "items": [
      {
        "name": "exampleItem",
        "publicUrl": "http://example.com/item",
        "size": "2 KB",
        "type": "image/png",
        "creationDate": "2024-09-16T00:00:00Z",
        "updatedDate": "2024-09-17T00:00:00Z",
        "metadata": "user123"
      }
    ],
    "size": "1024"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	CmsContentTreeResponseDto	false	Data content

ManagedFolderRequestDto

1
2
3
4


{
  "folderPath": "example_dir/",
  "user": "John_doe@example.com"
}

Name	Type	Required	Description
folderPath	string	true	Path of the managed folder
user	string	true	Email address of the user

ResourceObjectRequestDto

1
2
3
4
5


{
  "user": "John_doe@example.com",
  "objectName": "test-bucket.png",
  "fileContent": "UmVzZXQgeW91ciBwYXNzd29yZA=="
}

Name	Type	Required	Description
user	string	true	Email address of the user
objectName	string	true	Object name
fileContent	string	true	File path

UpdateObjectRequestDto

1
2
3
4
5


{
  "sourceObjectName": "oldObject.png",
  "updatedObjectName": "newObject.png",
  "user": "John_doe@example.com"
}

Name	Type	Required	Description
sourceObjectName	string	true	Name of the source object to be updated
updatedObjectName	string	true	Name of the object after the update
user	string	true	Email address of the user

CommunicationListResponse

 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "items": [
      {
        "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
        "type": "password_reset",
        "language": "en",
        "clientId": "vista360.auth.masmovil.com",
        "agentId": "aitor.tilla@masmovil.com",
        "externalId": "sale-12512321",
        "sms": {
          "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
          "senderInfo": "YOIGO",
          "countryCode": "34",
          "terminatingNumber": "623196241",
          "content": "Sms content example",
          "realTimeRequired": true,
          "scheduledTime": "2021-01-01T14:00:00.000000Z",
          "updatedTime": "2021-01-01T14:01:00.000000Z'",
          "deliveryStatus": "SUBMITTED",
          "sendingType": "EXTERNAL",
          "code": 202,
          "externalId": "sale-12512321",
          "warning": "Accepted but SMS not persisted",
          "error": "string"
        },
        "email": {
          "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
          "from": {
            "email": "noreply@masmovil.com",
            "name": "Masmovil info"
          },
          "to": {
            "email": "recipient@masmovil.es",
            "name": "Diego"
          },
          "subject": "Wonderful offer for you",
          "externalId": "sale-12512321",
          "deliveryStatus": "SUBMITTED",
          "mimeType": "text/html",
          "content": "<p>Welcome to </p>",
          "scheduledTime": "2021-01-01T14:00:00.000000Z",
          "updatedTime": "2021-01-01T14:01:00.000000Z'",
          "attachments": [
            "textFile.txt",
            "pdfFile.pdf"
          ],
          "code": 202,
          "warning": "Accepted but email not persisted",
          "error": "Email service temporary unavailable"
        },
        "requestTime": "2021-01-01T14:00:00.000000Z",
        "warning": "Accepted but communication not persisted",
        "scheduledTime": "2021-01-01T14:00:00.000000Z"
      }
    ],
    "type": "password_recovery",
    "clientId": "cuco.test-dev",
    "countryCode": "34",
    "terminatingNumber": "626626626",
    "destinationEmail": "diego.mateos@masmovil.com",
    "limit": 20,
    "offset": 0
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	CommunicationListResponseDto	false	Data content

CommunicationListResponseDto

 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63


{
  "items": [
    {
      "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
      "type": "password_reset",
      "language": "en",
      "clientId": "vista360.auth.masmovil.com",
      "agentId": "aitor.tilla@masmovil.com",
      "externalId": "sale-12512321",
      "sms": {
        "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
        "senderInfo": "YOIGO",
        "countryCode": "34",
        "terminatingNumber": "623196241",
        "content": "Sms content example",
        "realTimeRequired": true,
        "scheduledTime": "2021-01-01T14:00:00.000000Z",
        "updatedTime": "2021-01-01T14:01:00.000000Z'",
        "deliveryStatus": "SUBMITTED",
        "sendingType": "EXTERNAL",
        "code": 202,
        "externalId": "sale-12512321",
        "warning": "Accepted but SMS not persisted",
        "error": "string"
      },
      "email": {
        "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
        "from": {
          "email": "noreply@masmovil.com",
          "name": "Masmovil info"
        },
        "to": {
          "email": "recipient@masmovil.es",
          "name": "Diego"
        },
        "subject": "Wonderful offer for you",
        "externalId": "sale-12512321",
        "deliveryStatus": "SUBMITTED",
        "mimeType": "text/html",
        "content": "<p>Welcome to </p>",
        "scheduledTime": "2021-01-01T14:00:00.000000Z",
        "updatedTime": "2021-01-01T14:01:00.000000Z'",
        "attachments": [
          "textFile.txt",
          "pdfFile.pdf"
        ],
        "code": 202,
        "warning": "Accepted but email not persisted",
        "error": "Email service temporary unavailable"
      },
      "requestTime": "2021-01-01T14:00:00.000000Z",
      "warning": "Accepted but communication not persisted",
      "scheduledTime": "2021-01-01T14:00:00.000000Z"
    }
  ],
  "type": "password_recovery",
  "clientId": "cuco.test-dev",
  "countryCode": "34",
  "terminatingNumber": "626626626",
  "destinationEmail": "diego.mateos@masmovil.com",
  "limit": 20,
  "offset": 0
}

Name	Type	Required	Description
items	[CommunicationResponseDto]	false	Communications matching the provided criteria
type	string	false	Communication’s type used to filter
clientId	string	false	Communication’s client id used to filter
countryCode	string	false	Communication’s SMS country code used to filter
terminatingNumber	string	false	Communication’s terminating number used to filter
destinationEmail	string	false	Communication’s email destination address used to filter
limit	integer(int32)	false	Max number of communications retrieved
offset	integer(int32)	false	Offset used to paginate in conjunction with limit

CommunicationResponseDto

 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
45
46
47
48
49
50
51
52


{
  "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
  "type": "password_reset",
  "language": "en",
  "clientId": "vista360.auth.masmovil.com",
  "agentId": "aitor.tilla@masmovil.com",
  "externalId": "sale-12512321",
  "sms": {
    "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
    "senderInfo": "YOIGO",
    "countryCode": "34",
    "terminatingNumber": "623196241",
    "content": "Sms content example",
    "realTimeRequired": true,
    "scheduledTime": "2021-01-01T14:00:00.000000Z",
    "updatedTime": "2021-01-01T14:01:00.000000Z'",
    "deliveryStatus": "SUBMITTED",
    "sendingType": "EXTERNAL",
    "code": 202,
    "externalId": "sale-12512321",
    "warning": "Accepted but SMS not persisted",
    "error": "string"
  },
  "email": {
    "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
    "from": {
      "email": "noreply@masmovil.com",
      "name": "Masmovil info"
    },
    "to": {
      "email": "recipient@masmovil.es",
      "name": "Diego"
    },
    "subject": "Wonderful offer for you",
    "externalId": "sale-12512321",
    "deliveryStatus": "SUBMITTED",
    "mimeType": "text/html",
    "content": "<p>Welcome to </p>",
    "scheduledTime": "2021-01-01T14:00:00.000000Z",
    "updatedTime": "2021-01-01T14:01:00.000000Z'",
    "attachments": [
      "textFile.txt",
      "pdfFile.pdf"
    ],
    "code": 202,
    "warning": "Accepted but email not persisted",
    "error": "Email service temporary unavailable"
  },
  "requestTime": "2021-01-01T14:00:00.000000Z",
  "warning": "Accepted but communication not persisted",
  "scheduledTime": "2021-01-01T14:00:00.000000Z"
}

Name	Type	Required	Description
id	string(uuid)	false	Unique ID assigned to the communication
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Template language
clientId	string	false	Entity that requested the communication sending
agentId	string	false	Agent that requested the communication sending
externalId	string	false	Internal reference provided by the client system that could be used in later queries
sms	CommunicationResponseSmsDto	false	Information of the sent SMS
email	CommunicationResponseEmailDto	false	Information of the sent email
requestTime	string	false	Time and date when the communication was originally requested by its origin system. Format according to ISO 8601
warning	string	false	When the communication was processed but another unexpected error occurred this field contains a message about what happened
scheduledTime	string	false	Time and date when the communication was originally scheduled by its origin system. Format according to ISO 8601

CommunicationResponseEmailDto

 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


{
  "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
  "from": {
    "email": "noreply@masmovil.com",
    "name": "Masmovil info"
  },
  "to": {
    "email": "recipient@masmovil.es",
    "name": "Diego"
  },
  "subject": "Wonderful offer for you",
  "externalId": "sale-12512321",
  "deliveryStatus": "SUBMITTED",
  "mimeType": "text/html",
  "content": "<p>Welcome to </p>",
  "scheduledTime": "2021-01-01T14:00:00.000000Z",
  "updatedTime": "2021-01-01T14:01:00.000000Z'",
  "attachments": [
    "textFile.txt",
    "pdfFile.pdf"
  ],
  "code": 202,
  "warning": "Accepted but email not persisted",
  "error": "Email service temporary unavailable"
}

Name	Type	Required	Description
id	string(uuid)	false	Unique ID assigned to the processed email
from	CommunicationResponseEmailFromDto	false	none
to	CommunicationResponseEmailToDto	false	none
subject	string	false	Processed email’s subject
externalId	string	false	Internal reference provided by the client system that could be used in later queries
deliveryStatus	string	false	Processed email’s status, see https://developers.masstack.com/en/guides/communications/delivery_info for details. Possible values are: SUBMITTED, DROPPED, DEFERRED, REJECTED, DELIVERED, UNDELIVERABLE, OPEN, CLICKED
mimeType	string	false	Processed email’s content mimeType. This field is only present when sending a communication
content	string	false	Processed email’s content. This field is only present when sending a communication
scheduledTime	string	false	Scheduled delivery date and time for the email. Format according to ISO 8601
updatedTime	string	false	Last time when the email info has been updated. Format according to ISO 8601
attachments	[string]	false	Processed email attachments' file names. This field is only present when sending communications
code	integer(int32)	false	Response code of email provider
warning	string	false	When the email was submitted but another unexpected error occurred in email’s provider, this field contains a message about what happened
error	string	false	Error message explaining why the email could not be submitted

CommunicationResponseEmailFromDto

1
2
3
4


{
  "email": "noreply@masmovil.com",
  "name": "Masmovil info"
}

Name	Type	Required	Description
email	string	false	Email address used to deliver the message
name	string	false	A name or title associated with the sending email address

CommunicationResponseEmailToDto

1
2
3
4


{
  "email": "recipient@masmovil.es",
  "name": "Diego"
}

Name	Type	Required	Description
email	string	false	The intended recipient’s email address
name	string	false	The intended recipient’s name

CommunicationResponseSmsDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
  "senderInfo": "YOIGO",
  "countryCode": "34",
  "terminatingNumber": "623196241",
  "content": "Sms content example",
  "realTimeRequired": true,
  "scheduledTime": "2021-01-01T14:00:00.000000Z",
  "updatedTime": "2021-01-01T14:01:00.000000Z'",
  "deliveryStatus": "SUBMITTED",
  "sendingType": "EXTERNAL",
  "code": 202,
  "externalId": "sale-12512321",
  "warning": "Accepted but SMS not persisted",
  "error": "string"
}

Name	Type	Required	Description
id	string(uuid)	false	Unique ID assigned to the sent SMS.
senderInfo	string	false	Sender info to be shown in SMS, it can be text up to 11 characters or a phone number up to 15 digits
countryCode	string	false	International prefix without ‘+’. When not introduced, the application takes the Spanish prefix (34) as default
terminatingNumber	string	false	Destination phone number without international prefix
content	string	false	Sms content text
realTimeRequired	boolean	false	SMS delivery time criticality indicator. SMS with real time requirement are handled with higher priority than the others in case of overload
scheduledTime	string	false	Scheduled delivery date and time for the SMS. Format according to ISO 8601
updatedTime	string	false	Last time when the SMS stored info has been updated. Format according to ISO 8601
deliveryStatus	string	false	Sms status description, see https://developers.masstack.com/en/guides/communications/delivery_info for details. Possible values are: FAILED, REGISTERED, SUBMITTED, DELIVERED, EXPIRED, UNDELIVERABLE, REJECTED, ACCEPTED, DELETED
sendingType	string	false	Provider used to send the SMS
code	integer(int32)	false	Response code of SMS provider
externalId	string	false	Internal reference provided by the client system that could be used in later queries
warning	string	false	When the SMS was processed but another unexpected error occurred in SMS’s provider, this field contains a message about what happened
error	string	false	Error message explaining why the SMS could not be processed

CommunicationResponse

 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
45
46
47
48
49
50
51
52
53
54
55
56


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
    "type": "password_reset",
    "language": "en",
    "clientId": "vista360.auth.masmovil.com",
    "agentId": "aitor.tilla@masmovil.com",
    "externalId": "sale-12512321",
    "sms": {
      "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
      "senderInfo": "YOIGO",
      "countryCode": "34",
      "terminatingNumber": "623196241",
      "content": "Sms content example",
      "realTimeRequired": true,
      "scheduledTime": "2021-01-01T14:00:00.000000Z",
      "updatedTime": "2021-01-01T14:01:00.000000Z'",
      "deliveryStatus": "SUBMITTED",
      "sendingType": "EXTERNAL",
      "code": 202,
      "externalId": "sale-12512321",
      "warning": "Accepted but SMS not persisted",
      "error": "string"
    },
    "email": {
      "id": "c936ead5-7a6d-4fdb-9ad3-7cf4bff9d07f",
      "from": {
        "email": "noreply@masmovil.com",
        "name": "Masmovil info"
      },
      "to": {
        "email": "recipient@masmovil.es",
        "name": "Diego"
      },
      "subject": "Wonderful offer for you",
      "externalId": "sale-12512321",
      "deliveryStatus": "SUBMITTED",
      "mimeType": "text/html",
      "content": "<p>Welcome to </p>",
      "scheduledTime": "2021-01-01T14:00:00.000000Z",
      "updatedTime": "2021-01-01T14:01:00.000000Z'",
      "attachments": [
        "textFile.txt",
        "pdfFile.pdf"
      ],
      "code": 202,
      "warning": "Accepted but email not persisted",
      "error": "Email service temporary unavailable"
    },
    "requestTime": "2021-01-01T14:00:00.000000Z",
    "warning": "Accepted but communication not persisted",
    "scheduledTime": "2021-01-01T14:00:00.000000Z"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	CommunicationResponseDto	false	Data content

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


{
  "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"
  },
  "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
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

CommunicationRequestEmailDto

1
2
3
4


{
  "destinationEmail": "recipient@masmovil.es",
  "destinationName": "Diego"
}

Name	Type	Required	Description
destinationEmail	string	true	The intended recipient’s email address
destinationName	string	false	The intended recipient’s name

CommunicationRequestSmsDto

1
2
3
4


{
  "countryCode": "54",
  "terminatingNumber": "623196241"
}

Name	Type	Required	Description
countryCode	string	false	International prefix without ‘+’. When not introduced, the application takes the Spanish prefix (34) as default
terminatingNumber	string	true	Destination phone number without international prefix

CommunicationEmailPreviewDto

1
2
3
4
5
6
7
8
9


{
  "from": {
    "email": "noreply@masmovil.com",
    "name": "Masmovil info"
  },
  "subject": "Wonderful offer for you",
  "mimeType": "text/html",
  "content": "<p>Welcome to </p>"
}

Name	Type	Required	Description
from	CommunicationEmailPreviewFromDto	false	none
subject	string	false	Email’s subject
mimeType	string	false	Email’s content mimeType
content	string	false	Email’s content

CommunicationEmailPreviewFromDto

1
2
3
4


{
  "email": "noreply@masmovil.com",
  "name": "Masmovil info"
}

Name	Type	Required	Description
email	string	false	Email address used to deliver the message
name	string	false	A name or title associated with the sending email address

CommunicationPreviewResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "type": "password_reset",
    "language": "en",
    "sms": {
      "senderInfo": "YOIGO",
      "content": "Sms content example",
      "realTimeRequired": true
    },
    "email": {
      "from": {
        "email": "noreply@masmovil.com",
        "name": "Masmovil info"
      },
      "subject": "Wonderful offer for you",
      "mimeType": "text/html",
      "content": "<p>Welcome to </p>"
    },
    "warning": "Accepted replacing language"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	CommunicationPreviewResponseDto	false	Data content

CommunicationPreviewResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "type": "password_reset",
  "language": "en",
  "sms": {
    "senderInfo": "YOIGO",
    "content": "Sms content example",
    "realTimeRequired": true
  },
  "email": {
    "from": {
      "email": "noreply@masmovil.com",
      "name": "Masmovil info"
    },
    "subject": "Wonderful offer for you",
    "mimeType": "text/html",
    "content": "<p>Welcome to </p>"
  },
  "warning": "Accepted replacing language"
}

Name	Type	Required	Description
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Template language
sms	CommunicationSmsPreviewDto	false	Preview information of the SMS
email	CommunicationEmailPreviewDto	false	Preview information of the email
warning	string	false	Communication can be processed using the default language since the template with the one provided could not be found

CommunicationSmsPreviewDto

1
2
3
4
5


{
  "senderInfo": "YOIGO",
  "content": "Sms content example",
  "realTimeRequired": true
}

Name	Type	Required	Description
senderInfo	string	false	Sender info to be shown in SMS, it can be text up to 11 characters or a phone number up to 15 digits
content	string	false	Sms content text
realTimeRequired	boolean	false	SMS delivery time criticality indicator. SMS with real time requirement are handled with higher priority than the others in case of overload

ShortUrlResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "id": "masstack.link/1221221",
    "longUrl": "https://longurl.com/with/its/long/path",
    "link": "https://masstack.link/1221221",
    "createdTime": "2021-03-03T17:00:00Z",
    "updatedTime": "2022-03-03T17:00:00Z",
    "createdClientId": "nice.frontend",
    "createdAgentId": "linus.torvalds@masmovil.com",
    "updatedClientId": "nice.frontend",
    "updatedAgentId": "linus.torvalds@masmovil.com",
    "customSuffix": false
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	ShortUrlResponseDto	false	Data content

ShortUrlResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "id": "masstack.link/1221221",
  "longUrl": "https://longurl.com/with/its/long/path",
  "link": "https://masstack.link/1221221",
  "createdTime": "2021-03-03T17:00:00Z",
  "updatedTime": "2022-03-03T17:00:00Z",
  "createdClientId": "nice.frontend",
  "createdAgentId": "linus.torvalds@masmovil.com",
  "updatedClientId": "nice.frontend",
  "updatedAgentId": "linus.torvalds@masmovil.com",
  "customSuffix": false
}

Name	Type	Required	Description
id	string	false	Unique id for the short URL, usable to do queries about its metadata
longUrl	string	false	Long URL the created link redirects to
link	string	false	Shortened link
createdTime	string	false	Short URL creation timestamp according to ISO 8601
updatedTime	string	false	Short URL update timestamp according to ISO 8601
createdClientId	string	false	Client who created the shortened link
createdAgentId	string	false	Author who created the shortened link
updatedClientId	string	false	Client who last updated the shortened link
updatedAgentId	string	false	Author who last updated the shortened link
customSuffix	boolean	false	Flag to indicate whether the shortened link has a custom suffix

CreateShortUrlRequestDto

1
2
3
4


{
  "longUrl": "https://longurl.com/with/its/long/path",
  "customSuffix": "helpPage"
}

Name	Type	Required	Description
longUrl	string	false	Long URL that is required to be shortened
customSuffix	string	false	Custom suffix to use instead of generating a random string

ArgumentDefinitionDto

 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62


[
  {
    "name": "userName",
    "type": "String",
    "sensitive": false
  },
  {
    "name": "bonusList",
    "type": "StringList",
    "sensitive": false
  },
  {
    "name": "productNameAndInfo",
    "type": "StringMap",
    "sensitive": false
  },
  {
    "name": "maxRetries",
    "type": "Number",
    "sensitive": false
  },
  {
    "name": "resetLink",
    "type": "Link",
    "sensitive": true
  },
  {
    "name": "birthCountry",
    "type": "LocaleRegion",
    "sensitive": false
  },
  {
    "name": "expiration",
    "type": "Date",
    "sensitive": false
  },
  {
    "name": "mfaRequired",
    "type": "Boolean",
    "sensitive": false
  },
  {
    "name": "attached.pdf",
    "type": "Attachment",
    "sensitive": false
  },
  {
    "name": "image_png",
    "type": "EmbeddedImage",
    "sensitive": false
  },
  {
    "name": "qrCodeImage",
    "type": "QrInfo",
    "sensitive": false
  },
  {
    "name": "attachments",
    "type": "AttachmentsMap",
    "sensitive": false
  }
]

Name	Type	Required	Description
name	string	true	Argument name that could be used in communication templates
type	string	true	Data type of the argument. Possible values are: String, StringList, StringMap, Number, Link,LocaleRegion, Date, Boolean, Attachment, EmbeddedImage or QrInfo
sensitive	boolean	false	Whether the argument is sensitive or not. Sensitive arguments are not persisted

CommunicationTypeResponse

 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


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "code": "password_reset",
    "description": "Provides the user a link to reset his password",
    "realTimeRequired": true,
    "deliveryWindow": "ANYDAY_8AM8PM",
    "sendingType": "EXTERNAL",
    "createdTime": "2021-01-01T14:00:00.000000Z",
    "updatedTime": "2021-01-03T20:00:00.000000Z",
    "arguments": {
      "userName": "String",
      "maxRetries": "Number",
      "resetLink": "Link",
      "birthCountry": "LocaleRegion",
      "expiration": "Date",
      "mfaRequired": "Boolean",
      "attached.pdf": "Attachment",
      "image_png": "EmbeddedImage",
      "qrCodeImage": "QrInfo",
      "attachments": "AttachmentsMap"
    }
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	CommunicationTypeResponseDto	false	Data content

CommunicationTypeResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


{
  "code": "password_reset",
  "description": "Provides the user a link to reset his password",
  "realTimeRequired": true,
  "deliveryWindow": "ANYDAY_8AM8PM",
  "sendingType": "EXTERNAL",
  "createdTime": "2021-01-01T14:00:00.000000Z",
  "updatedTime": "2021-01-03T20:00:00.000000Z",
  "arguments": {
    "userName": "String",
    "maxRetries": "Number",
    "resetLink": "Link",
    "birthCountry": "LocaleRegion",
    "expiration": "Date",
    "mfaRequired": "Boolean",
    "attached.pdf": "Attachment",
    "image_png": "EmbeddedImage",
    "qrCodeImage": "QrInfo",
    "attachments": "AttachmentsMap"
  }
}

Name	Type	Required	Description
code	string	false	Unique identification code for the communication type
description	string	false	Long text description of the communication purpose
realTimeRequired	boolean	false	Flag indicating if the communication early delivery is critical. Communications with real time requirement are handled with higher priority than the others in case of overload
deliveryWindow	string	false	Communication’s delivery window. If another scheduled time is defined, this value will be ignored. Possible values are: ANYDAY_ANYTIME, ANYDAY_8AM8PM
sendingType	string	false	Provider that will be used to send SMS communications. Possible values are: DEFAULT, EXTERNAL
createdTime	string	false	Communication type’s creation date and time. Format according to ISO 8601
updatedTime	string	false	Last time the communication type was modified. Format according to ISO 8601
arguments	[ArgumentDefinitionDto]	false	Variable arguments that can be used in the communication and its type

CommunicationTypeListResponseDto

 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


{
  "commit": "v2.10.1",
  "items": [
    {
      "code": "password_reset",
      "description": "Provides the user a link to reset his password",
      "realTimeRequired": true,
      "deliveryWindow": "ANYDAY_8AM8PM",
      "sendingType": "EXTERNAL",
      "createdTime": "2021-01-01T14:00:00.000000Z",
      "updatedTime": "2021-01-03T20:00:00.000000Z",
      "arguments": {
        "userName": "String",
        "maxRetries": "Number",
        "resetLink": "Link",
        "birthCountry": "LocaleRegion",
        "expiration": "Date",
        "mfaRequired": "Boolean",
        "attached.pdf": "Attachment",
        "image_png": "EmbeddedImage",
        "qrCodeImage": "QrInfo",
        "attachments": "AttachmentsMap"
      }
    }
  ],
  "type": "shipping_in_transit",
  "description": "Reclamación",
  "realTimeRequired": "true",
  "deliveryWindow": "ANYDAY_ANYTIME",
  "sendingType": "DEFAULT",
  "argument": "name",
  "limit": 20,
  "offset": 0,
  "total": 40
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
items	[CommunicationTypeResponseDto]	false	All types available in database
type	string	false	Type used for search
description	string	false	Description used for search
realTimeRequired	string	false	Search based on real time required
deliveryWindow	string	false	Delivery window used for search
sendingType	string	false	Sending type used for search
argument	string	false	Argument used for search
limit	integer(int32)	false	Max number of communication types retrieved
offset	integer(int32)	false	Offset used to paginate in conjunction with limit
total	integer(int32)	false	Total number of records

CommunicationTypeRequestDto

 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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69


{
  "code": "password_reset",
  "description": "Provides the user a link to reset his password",
  "realTimeRequired": true,
  "deliveryWindow": "ANYDAY_8AM8PM",
  "sendingType": "EXTERNAL",
  "arguments": [
    {
      "name": "userName",
      "type": "String",
      "sensitive": false
    },
    {
      "name": "bonusList",
      "type": "StringList",
      "sensitive": false
    },
    {
      "name": "productNameAndInfo",
      "type": "StringMap",
      "sensitive": false
    },
    {
      "name": "maxRetries",
      "type": "Number",
      "sensitive": false
    },
    {
      "name": "resetLink",
      "type": "Link",
      "sensitive": true
    },
    {
      "name": "birthCountry",
      "type": "LocaleRegion",
      "sensitive": false
    },
    {
      "name": "expiration",
      "type": "Date",
      "sensitive": false
    },
    {
      "name": "mfaRequired",
      "type": "Boolean",
      "sensitive": false
    },
    {
      "name": "attached.pdf",
      "type": "Attachment",
      "sensitive": false
    },
    {
      "name": "image_png",
      "type": "EmbeddedImage",
      "sensitive": false
    },
    {
      "name": "qrCodeImage",
      "type": "QrInfo",
      "sensitive": false
    },
    {
      "name": "attachments",
      "type": "AttachmentsMap",
      "sensitive": false
    }
  ]
}

Name	Type	Required	Description
code	string	true	Unique identification code for the communication type. It can only contain alphanumeric characters separated with underscores. It is validated under this regular expression: ^[a-z0-9][a-z0-9_]{0,38}[a-z0-9]$
description	string	true	Long text description of the communication purpose
realTimeRequired	boolean	false	Flag indicating if the communication early delivery is critical. Communications with real time requirement are handled with higher priority than the others in case of overload
deliveryWindow	string	false	Communication’s delivery window. It is used to define the time slot in which the communication can be sent. Possible values are always preceded by ANYDAY_ and any valid window within the same day. For example: ANYDAY_ANYTIME, ANYDAY_8AM8PM, ANYDAY_8AM12PM, ANYDAY_12PM4PM or ANYDAY_4PM8PM.
sendingType	string	false	If set to EXTERNAL, an external provider will be used to send the communication SMS. Possible values are: DEFAULT, EXTERNAL
arguments	[ArgumentDefinitionDto]	true	Variable arguments that can be used in the communication and its type: String, StringList, StringMap, Number, Link,LocaleRegion, Date, Boolean, Attachment, EmbeddedImage or QrInfo

EmailExampleExpectedOutputResponseDto

1
2
3
4
5
6
7


{
  "from": {
    "email": "noreply@masmovil.com",
    "name": "Masmovil info"
  },
  "subject": "Wonderful offer for you"
}

Name	Type	Required	Description
from	EmailExampleResponseFromExpectedOutputDto	false	none
subject	string	false	Processed email’s subject

EmailExampleResponseFromExpectedOutputDto

1
2
3
4


{
  "email": "noreply@masmovil.com",
  "name": "Masmovil info"
}

Name	Type	Required	Description
email	string	false	Email address that will be use to deliver the message
name	string	false	A name or title associated with the sending email address

ExampleResponse

 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


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
    "type": "password_reset",
    "language": "es",
    "channel": "sms",
    "requestRef": "https://jiranext.masmovil.com/browse/CUCO-817",
    "description": "Mobile subscription contract sending",
    "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"
    },
    "expectedOutput": {
      "senderInfo": "MASMOVIL",
      "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
    },
    "createdTime": "2021-01-01T14:00:00.000000Z",
    "updatedTime": "2021-01-03T20:00:00.000000Z",
    "createdClientId": "masstack.auth.masmovil.com",
    "updatedClientId": "masstack.auth.masmovil.com",
    "createdAgentId": "agent@masmovil.com",
    "updatedAgentId": "agent@masmovil.com"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	ExampleResponseDto	false	Data content

ExampleResponseDto

 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


{
  "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
  "type": "password_reset",
  "language": "es",
  "channel": "sms",
  "requestRef": "https://jiranext.masmovil.com/browse/CUCO-817",
  "description": "Mobile subscription contract sending",
  "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"
  },
  "expectedOutput": {
    "senderInfo": "MASMOVIL",
    "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
  },
  "createdTime": "2021-01-01T14:00:00.000000Z",
  "updatedTime": "2021-01-03T20:00:00.000000Z",
  "createdClientId": "masstack.auth.masmovil.com",
  "updatedClientId": "masstack.auth.masmovil.com",
  "createdAgentId": "agent@masmovil.com",
  "updatedAgentId": "agent@masmovil.com"
}

Name	Type	Required	Description
id	string(uuid)	false	UUID of the registered example as generated by database
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Example’s language(ISO 639-1)
channel	string	false	Channel of example
requestRef	string	false	Reference of issue where example was requested
description	string	false	Comprehensive description of the purpose of the example
arguments	object	false	Input arguments used in the example
» additionalProperties	object	false	Input arguments used in the example
expectedOutput	ExampleResponseExpectedOutput	false	Expected content of example for set of provided arguments. It is different depending on the channel
createdTime	string	false	Example’s creation date and time according to ISO 8601 format
updatedTime	string	false	Last time the example was modified. Format according to ISO 8601
createdClientId	string	false	System or frontend that created the example identified by its audience.
updatedClientId	string	false	System or frontend that requested the last example update identified by its audience.
createdAgentId	string	false	Id of the agent that made the request if available, otherwise N/A.
updatedAgentId	string	false	AgentId that requested example update if available, otherwise N/A.

ExampleResponseExpectedOutput

1
2
3
4


{
  "senderInfo": "MASMOVIL",
  "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
}

Name	Type	Required	Description
anonymous	SmsExampleExpectedOutputResponseDto	false	none

Name	Type	Required	Description
anonymous	EmailExampleExpectedOutputResponseDto	false	none

SmsExampleExpectedOutputResponseDto

1
2
3
4


{
  "senderInfo": "MASMOVIL",
  "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
}

Name	Type	Required	Description
senderInfo	string	false	Sender info to be shown in SMS, it can be text up to 11 characters or a phone number up to 15 digits
content	string	false	Sms example content

ExampleListResponse

 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
45
46
47
48
49


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "items": [
      {
        "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
        "type": "password_reset",
        "language": "es",
        "channel": "sms",
        "requestRef": "https://jiranext.masmovil.com/browse/CUCO-817",
        "description": "Mobile subscription contract sending",
        "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"
        },
        "expectedOutput": {
          "senderInfo": "MASMOVIL",
          "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
        },
        "createdTime": "2021-01-01T14:00:00.000000Z",
        "updatedTime": "2021-01-03T20:00:00.000000Z",
        "createdClientId": "masstack.auth.masmovil.com",
        "updatedClientId": "masstack.auth.masmovil.com",
        "createdAgentId": "agent@masmovil.com",
        "updatedAgentId": "agent@masmovil.com"
      }
    ],
    "limit": 50,
    "offset": 0,
    "total": 5,
    "type": "password_recovery",
    "language": "es",
    "channel": "sms",
    "description": "Recover your password",
    "requestRef": "CUCO-123",
    "content": "Click in the following link to recover your password",
    "subject": "Recover your password"
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	ExampleListResponseDto	false	Data content

ExampleListResponseDto

 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
45


{
  "items": [
    {
      "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
      "type": "password_reset",
      "language": "es",
      "channel": "sms",
      "requestRef": "https://jiranext.masmovil.com/browse/CUCO-817",
      "description": "Mobile subscription contract sending",
      "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"
      },
      "expectedOutput": {
        "senderInfo": "MASMOVIL",
        "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
      },
      "createdTime": "2021-01-01T14:00:00.000000Z",
      "updatedTime": "2021-01-03T20:00:00.000000Z",
      "createdClientId": "masstack.auth.masmovil.com",
      "updatedClientId": "masstack.auth.masmovil.com",
      "createdAgentId": "agent@masmovil.com",
      "updatedAgentId": "agent@masmovil.com"
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 5,
  "type": "password_recovery",
  "language": "es",
  "channel": "sms",
  "description": "Recover your password",
  "requestRef": "CUCO-123",
  "content": "Click in the following link to recover your password",
  "subject": "Recover your password"
}

Name	Type	Required	Description
items	[ExampleResponseDto]	false	Examples matching the provided criteria
limit	integer(int32)	false	Max number of examples retrieved
offset	integer(int32)	false	Offset used to paginate in conjunction with limit
total	integer(int32)	false	Total number of records
type	string	false	Communication type filter
language	string	false	Language filter
channel	string	false	Channel filter
description	string	false	Description filter
requestRef	string	false	Request reference filter
content	string	false	Content filter
subject	string	false	Email subject filter

ExampleRequestDto

 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


{
  "id": "30387cbc-e3da-4c2a-be92-8aad3438908a",
  "type": "password_reset",
  "language": "en",
  "channel": "sms",
  "requestRef": "https://jiranext.masmovil.com/browse/CUCO-817",
  "description": "Mobile subscription contract sending",
  "expectedOutput": {
    "senderInfo": "MasMovil",
    "content": "Bienvenido a MasMovil!"
  },
  "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"
  }
}

Name	Type	Required	Description
id	string(uuid)	false	UUID to be used as identifier of the example. It must be unique in the system
type	string	true	Communication type code according to the ones previously defined in the system
language	string	true	Example’s language(ISO 639-1)
channel	string	true	Channel of example
requestRef	string	false	Reference of issue where example was requested
description	string	false	Comprehensive description of the purpose of the example
expectedOutput	object	true	Expected output required for the example definition. It is different depending on the channel
arguments	object	false	Input arguments used in the example. Name and value of arguments must be coherent with registered type’s arguments.
» additionalProperties	object	false	Input arguments used in the example. Name and value of arguments must be coherent with registered type’s arguments.

EmailOutput

1
2
3
4
5
6
7
8


{
  "from": {
    "email": "noreply@masmovil.com",
    "name": "Masmovil info"
  },
  "subject": "Wonderful offer for you",
  "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
}

Name	Type	Required	Description
from	EmailOutputFrom	false	none
subject	string	false	Actual subject output
content	string	false	Actual email content output

EmailOutputFrom

1
2
3
4


{
  "email": "noreply@masmovil.com",
  "name": "Masmovil info"
}

Name	Type	Required	Description
email	string	false	Processed template’s from email address
name	string	false	Processed template’s from name

Error

1
2
3
4
5


{
  "field": "string",
  "expected": "string",
  "returned": "string"
}

Name	Type	Required	Description
field	string	false	Mismatching field name
expected	string	false	Expected field’s value
returned	string	false	Actual field’s value

ExampleValidateResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "pass": true,
  "errors": [
    {
      "field": "string",
      "expected": "string",
      "returned": "string"
    }
  ],
  "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
  "type": "password_reset",
  "language": "es",
  "channel": "sms",
  "description": "Mobile subscription contract sending",
  "output": {
    "senderInfo": "MASMOVIL",
    "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
  }
}

Name	Type	Required	Description
pass	boolean	false	Indicates whether the template output matches the example expected data
errors	[Error]	false	List of errors when example and template output does not match
id	string(uuid)	false	UUID of the registered example
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Example’s language (ISO 639-1)
channel	string	false	Channel of example
description	string	false	Comprehensive description of the purpose of the example
output	Output	false	Example’s output data

ExampleValidationResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "pass": true,
    "errors": [
      {
        "field": "string",
        "expected": "string",
        "returned": "string"
      }
    ],
    "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
    "type": "password_reset",
    "language": "es",
    "channel": "sms",
    "description": "Mobile subscription contract sending",
    "output": {
      "senderInfo": "MASMOVIL",
      "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
    }
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	ExampleValidateResponseDto	false	Report of validated examples against the template

Output

1
2
3
4


{
  "senderInfo": "MASMOVIL",
  "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
}

Name	Type	Required	Description
anonymous	SmsOutput	false	none

Name	Type	Required	Description
anonymous	EmailOutput	false	none

SmsOutput

1
2
3
4


{
  "senderInfo": "MASMOVIL",
  "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
}

Name	Type	Required	Description
senderInfo	string	false	Actual sender info output
content	string	false	Actual sms content output

EmailTemplateDataResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "from": {
    "email": "noreply@masmovil.com",
    "name": "Masmovil info"
  },
  "subject": "Wonderful offer for you",
  "mimeType": "text/html",
  "content": "Hi <th th:text=\\\"${name}\\\">Juan</th>, welcome to MasMovil!",
  "attachments": [
    "textFile.txt",
    "pdfFile.pdf"
  ]
}

Name	Type	Required	Description
from	EmailTemplateResponseFromDataDto	false	none
subject	string	false	Processed email’s subject
mimeType	string	true	The MIME type of the content to be included in the email
content	string	false	Email’s template content based on the specified MIME type
attachments	[string]	false	This field is only available when previewing templates. It shows what attachment would be added when sending the communication

EmailTemplateResponseFromDataDto

1
2
3
4


{
  "email": "noreply@masmovil.com",
  "name": "Masmovil info"
}

Name	Type	Required	Description
email	string	false	Email address that will be use to deliver the message
name	string	false	A name or title associated with the sending email address

SmsTemplateDataResponseDto

1
2
3
4


{
  "senderInfo": "MASMOVIL",
  "content": "Hi [(${name})], enter [(${resetLink})] to reset password"
}

Name	Type	Required	Description
senderInfo	string	false	Sender info to be shown in SMS, it can be text up to 11 characters or a phone number up to 15 digits
content	string	false	Sms template content

TemplateResponseData

1
2
3
4


{
  "senderInfo": "MASMOVIL",
  "content": "Hi [(${name})], enter [(${resetLink})] to reset password"
}

Name	Type	Required	Description
anonymous	SmsTemplateDataResponseDto	false	none

Name	Type	Required	Description
anonymous	EmailTemplateDataResponseDto	false	none

TemplateResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "commit": "v2.10.1",
  "type": "password_reset",
  "language": "es",
  "channel": "sms",
  "data": {
    "senderInfo": "MASMOVIL",
    "content": "Hi [(${name})], enter [(${resetLink})] to reset password"
  },
  "createdTime": "2021-01-01T14:00:00.000000Z",
  "updatedTime": "2021-01-03T20:00:00.000000Z"
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Template language
channel	string	false	Channel where the template is applicable
data	TemplateResponseData	false	Data required for the template definition. It is different depending on the channel
createdTime	string	false	Template’s creation date and time according to ISO 8601 format
updatedTime	string	false	Last time the template was modified. Format according to ISO 8601

TemplatesResponseDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


{
  "commit": "v2.10.1",
  "items": [
    {
      "commit": "v2.10.1",
      "type": "password_reset",
      "language": "es",
      "channel": "sms",
      "data": {
        "senderInfo": "MASMOVIL",
        "content": "Hi [(${name})], enter [(${resetLink})] to reset password"
      },
      "createdTime": "2021-01-01T14:00:00.000000Z",
      "updatedTime": "2021-01-03T20:00:00.000000Z"
    }
  ],
  "type": "password_reset",
  "language": "es",
  "channel": "sms",
  "subject": "Shipping in transit",
  "limit": 20,
  "offset": 0,
  "total": 40
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
items	[TemplateResponseDto]	false	Templates matching the provided criteria
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Template language
channel	string	false	Channel through which the communication will be sent
subject	string	false	Subject of the email template
limit	integer(int32)	false	Max number of templates retrieved
offset	integer(int32)	false	Offset used to paginate in conjunction with limit
total	integer(int32)	false	Total number of records

EmailTemplateRequestDataDto

1
2
3
4
5
6
7
8
9


{
  "from": {
    "email": "bm9yZXBseUBtYXNtb3ZpbC5jb20=",
    "name": "TWFzbW92aWwgaW5mbw=="
  },
  "subject": "V29uZGVyZnVsIG9mZmVyIGZvciB5b3Uh",
  "mimeType": "text/html",
  "content": "SGkgPHRoIHRoOnRleHQ9IiR7bmFtZX0iPkp1YW48L3RoPiwgd2VsY29tZSB0byBNYXNNb3ZpbCE="
}

Name	Type	Required	Description
from	EmailTemplateRequestFromDataDto	false	none
subject	string	false	Email’s subject Base64 encoded
mimeType	string	true	The MIME type of the content to be included in the email
content	string	true	Base64 encoded content for the email template

EmailTemplateRequestFromDataDto

1
2
3
4


{
  "email": "bm9yZXBseUBtYXNtb3ZpbC5jb20=",
  "name": "TWFzbW92aWwgaW5mbw=="
}

Name	Type	Required	Description
email	string	true	Email address used to deliver the message Base64 encoded
name	string	false	A name or title associated with the sending email address Base64 encoded

SmsTemplateRequestDataDto

1
2
3
4


{
  "senderInfo": "YOIGO",
  "content": "SGkgWygke25hbWV9KV0sIGVudGVyIFsoJHtyZXNldExpbmt9KV0gdG8gcmVzZXQgcGFzc3dvcmQ="
}

Name	Type	Required	Description
senderInfo	string	false	Sender info to be shown in SMS, it can be text up to 11 characters or a phone number up to 15 digits
content	string	true	Template content encoded in base64 , multiple alphabets are supported, see https://developers.masstack.com/en/guides/communications/supported for details

TemplateRequestData

1
2
3
4


{
  "senderInfo": "YOIGO",
  "content": "SGkgWygke25hbWV9KV0sIGVudGVyIFsoJHtyZXNldExpbmt9KV0gdG8gcmVzZXQgcGFzc3dvcmQ="
}

Name	Type	Required	Description
anonymous	SmsTemplateRequestDataDto	false	none

Name	Type	Required	Description
anonymous	EmailTemplateRequestDataDto	false	none

TemplateRequestDto

 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


{
  "type": "password_reset",
  "language": "en",
  "channel": "sms",
  "data": {
    "senderInfo": "YOIGO",
    "content": "SGkgWygke25hbWV9KV0sIGVudGVyIFsoJHtyZXNldExpbmt9KV0gdG8gcmVzZXQgcGFzc3dvcmQ="
  },
  "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"
  }
}

Name	Type	Required	Description
type	string	true	Communication type code according to the ones previously defined in the system
language	string	true	Template language
channel	string	true	Template channel
data	TemplateRequestData	true	Data required for the template definition. It is different depending on the channel
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. This field is only required when previewing templates
» 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. This field is only required when previewing templates

TemplateValidateResponseDto

 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


{
  "pass": true,
  "errors": [
    {
      "field": "string",
      "expected": "string",
      "returned": "string"
    }
  ],
  "type": "password_reset",
  "language": "es",
  "channel": "sms",
  "report": [
    {
      "pass": true,
      "errors": [
        {
          "field": "string",
          "expected": "string",
          "returned": "string"
        }
      ],
      "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
      "type": "password_reset",
      "language": "es",
      "channel": "sms",
      "description": "Mobile subscription contract sending",
      "output": {
        "senderInfo": "MASMOVIL",
        "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
      }
    }
  ]
}

Name	Type	Required	Description
pass	boolean	false	Indicates whether the template output matches the example expected data
errors	[Error]	false	List of errors when example and template output does not match
type	string	false	Communication type code according to the ones previously defined in the system
language	string	false	Template’s language (ISO 639-1)
channel	string	false	Template’s channel
report	[ExampleValidateResponseDto]	false	Report of validated examples against the template

TemplateValidationResponse

 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


{
  "commit": "v2.10.1",
  "id": "57cff118-984f-473c-a6ad-5ba51baed0dd",
  "data": {
    "pass": true,
    "errors": [
      {
        "field": "string",
        "expected": "string",
        "returned": "string"
      }
    ],
    "type": "password_reset",
    "language": "es",
    "channel": "sms",
    "report": [
      {
        "pass": true,
        "errors": [
          {
            "field": "string",
            "expected": "string",
            "returned": "string"
          }
        ],
        "id": "4e95a8bb-1616-4505-942e-007358e2f1e4",
        "type": "password_reset",
        "language": "es",
        "channel": "sms",
        "description": "Mobile subscription contract sending",
        "output": {
          "senderInfo": "MASMOVIL",
          "content": "Hi Aitor Tilla, enter masstack.link/ABC123 to reset password"
        }
      }
    ]
  }
}

Name	Type	Required	Description
commit	string	false	Service version handling the request
id	string	false	Specific resource identifier
data	TemplateValidateResponseDto	false	Data content

TemplateValidateRequestDto

1
2
3
4
5


{
  "type": "password_reset",
  "language": "en",
  "channel": "sms"
}

Name	Type	Required	Description
type	string	true	Communication type code according to the ones previously defined in the system
language	string	true	Template’s language (ISO 639-1)
channel	string	true	Template’s channel