Thank you for filling out the form. One of our mobile experts will be in touch shortly to discuss your inquiry.
If you have any other questions please feel free to email us directly at info@mitto.ch
Number Masking Use Cases
This page provides details about number masking use cases. Use the examples provided to build more complex applications. Number masking use cases include:
Applications
- Create an Application. – Create a new application. This is required to set up a number masking pool.
- Get a List of Applications. – See a list of applications you created.
- Get a Single Application. – Retrieve details about a specific application.
- Update an Application. – Update details about an application.
- Delete an Application. – Get rid of applications you don’t need.
Phone Numbers
- Get a List of Available Phone Numbers. – Find out what numbers you can use for number masking. Search for numbers with specific country and area codes.
- Retrieve a Single Available Phone Number. – Provide specific details and retrieve a specific phone number to check availability.
- Add a Phone Number to Your Application. – Add a phone number to your application’s number masking pool.
- Get a List of Mask Numbers. – Find out what numbers you use for number masking across all applications.
- Retrieve a Single Mask Number. – Retrieve details about a specific number used for number masking.
- Update a Mask Number. – Update whether a masked number is reserved or available for use.
- Remove a Masked Number From the Application Masked Number Pool. – Take a number from one application and add it to a different application. You can also remove it from mask number pools all together.
Contexts
- Create a Context. – Connect participants by a creating a context for them.
- Get a List of Contexts. – See what contexts are active. (Active means there are two participants communicating.)
- Get a Single Context. – Retrieve details about a specific context.
- Update a Context. – Update a context’s details such as status or the date it expires.
- Delete a Context. – Delete inactive contexts that you no longer use.
- Add Participants to a Context. – Add up to two participants to a context so they can converse with their numbers masked.
- Get a List of Context Participants. – Retrieve participants on all contexts across all applications.
- Retrieve a Single Participant From a Context. – Fetch details about a specific participant in a context.
- Remove a Participant From a Context. – Disconnect a participant from a context.
Interactions
- Get a List of Interactions. – Sort and filter interactions to review.
- Get a Single Interaction. – Retrieve details about a single interaction.
Create an Application
Create applications with the Number Masking API. For each application, assign phone numbers to create a pool of mask numbers. For example, imagine a ride sharing application. Whenever a ride is booked by a customer, you create a new context and add participants (driver and customer) to that context. Number Masking automatically selects the mask number from the pool and assigns it to participants. Whenever a participant calls a mask number, the other participant in the context receives a call from their assigned mask number, maintaining complete privacy.
Request
curl -X POST \
'https://cpaas.mittoapi.com/numbermasking/applications' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{"enterpriseSid":"EN838bcdf35f9d421fad3ab516195b873b", \
"name" : "MyTestApplication"
}'
Response
Successful Response
{
"code":200,
"message":"OK",
“data”:
{
“sid":"NMAb6eb071d21124dbab20b095c25f1274f",
“enterpriseSid”: “ EN838bcdf35f9d421fad3ab516195b873b”,
“name”:”MyTestApplication”,
“status”:”open”,
“ttl”:”0”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274f "
}
}
Unsuccessful Response
{
"errorCode": "461",
"message": "Application name not unique",
"data": {
"name": "App4",
"enterpriseSid": "EN995ef31d1ae64ef48f45685cb67dca1f"
}
}
Get a List of Applications
You can retrieve a complete list of applications you created. You can specify page and page length as part of your request.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/applications/search?pageSize=2&page=0' \
--user '{your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"result": [
{
“sid":"NMAb6eb071d21124dbab20b095c25f1274f",
“name”:”MyTestApplication”,
“status”:”open”,
“ttl”:”0”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”: "email@company.com”,
"dateCreated":“2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274f "
},
{
“sid":"NMAb6eb071d21124dbab20b095c25f1274e",
“name”:”DeliveryApplication”,
“status”:”open”,
“ttl”:”0”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-23 09:53:51",
"dateUpdated":"2019-07-23 09:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274e "
}
],
"pageSize": 2,
"total": 3,
"page": 0,
"numPages": 2,
"start": 0,
"end": 1,
"firstPageUri": "/messageexchange/enterprise/search/?pageSize=2&page=0",
"nextPageUri": "/messageexchange/enterprise/search/?pageSize=2&page=1",
"uri": "/messageexchange/enterprise/search/?pageSize=2&page=0"
},
"code": 200,
"message": "OK"
}
Get a Single Application
Retrieve a single application by its unique application ID.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/applications/search?APP36eb071d21124dbab20b095c25f1274f' \
--user '{your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
“sid":"APPbceb071d21124dbab20b095c25f1274f",
“name”:”MyTestApplication”,
“status”:”open”,
“ttl”:”0”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”: "email@mycompany.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"uri":/numbermasking/applications/search/APPbceb071d21124dbab20b095c25f1274f "
},
"code": 200,
"message": "OK"
}
Update an Application
You can update an application with a PUT request. You can use the request parameters detailed for creating an application.
Request
curl -X PUT \
'https://cpaas.mittoapi.com/numbermasking/applications/APP36eb071d21124dbab20b095c25f1274f' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"ttl" : "600"
}
Response
{
"data": {
“sid":"NMAb6eb071d21124dbab20b095c25f1274f",
“name”:”MyTestApplication”,
“status”:”open”,
“ttl”:”600”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”:”email@mycompany.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274f "
},
"code": 200,
"message": "OK"
}
Delete an Application
If you no longer need an application, you can delete it. Be careful, deletion is permanent.
Request
curl -X DELETE \
'https://cpaas.mittoapi.com/numbermasking/applications/NMAb6eb071d21124dbab20b095c25f1274f' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
Successful Response
{
"data": {
“sid":"NMAb6eb071d21124dbab20b095c25f1274f",
“name”:”MyTestApplication”,
“status”:”deleted”,
“ttl”:”600”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-08-22 09:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274f "
},
"code": 200,
"message": "OK"
}
Unsuccessful Response
{
"code":462,
"message":"Application status not open",
“data”:
{
“sid":"NMAb6eb071d21124dbab20b095c25f1274f",
“name”:”MyTestApplication”,
“status”:”deleted”,
“ttl”:”600”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-08-22 09:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274f "
}
}
Get a List of Available Phone Numbers
You can see the phone numbers reserved for your applications by retrieving a list of available phone numbers.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/phonenumbers/search?pageSize=2&page=0' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"result": [
{
"sid":"PN0b4201c6c87749f29367e6cf000686cb",
"friendlyName":"Test Number",
"phoneNumber":"12013507693",
"capabilities": {
"voice_capable": true,
"sms_capable": false,
"mms_capable": false,
"fax_capable": false
},
“applicationSid”:”xxx”
"url":/numbermasking/phonenumbers/search/PN0b4201c6c87749f29367e6cf000686cb"
},
{
{
"sid":"PN0b4201c6c87749f29367e6cf000686ce",
"friendlyName":"Mask Number 2",
"phoneNumber":"12012444945",
"capabilities": {
"voice_capable": true,
"sms_capable": false,
"mms_capable": false,
"fax_capable": false
},
"url":/numbermasking/phonenumbers/search/PN0b4201c6c87749f29367e6cf000686ce"
}
}
],
"pageSize": 2,
"total": 3,
"page": 0,
"numPages": 2,
"start": 0,
"end": 1,
"firstPageUri": "/numbermasking/phonenumbers/search/?pageSize=2&page=0",
"nextPageUri": "/numbermasking/phonenumbers/search/?pageSize=2&page=1",
"uri": "/numbermasking/phonenumbers/search/?pageSize=2&page=0"
},
"code": 200,
"message": "OK"
}
Retrieve a Single Available Phone Number
You can retrieve an individual phone number that’s available for masking if you know the number’s ID.
Request
curl -X GET \
https://cpaas.mittoapi.com/numbermasking/phonenumbers/search/PN0b4201c6c87749f29367e6cf000686cb \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"sid":"PN0b4201c6c87749f29367e6cf000686cb",
"friendlyName":"Test Number",
"phoneNumber":"12013507693",
"capabilities": {
"voice_capable": true,
"sms_capable": false,
"mms_capable": false,
"fax_capable": false
},
"url":/numbermasking/phonenumbers/search/PN0b4201c6c87749f29367e6cf000686cb"
},
"code": 200,
"message": "OK"
}
Add a Phone Number to Your Application
Your application needs a pool of phone numbers to use for masking. Assign individual numbers to your application with this request.
Request
curl -X POST \
'https://cpaas.mittoapi.com/numbermasking/maskednumbers' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"sid" : "PN67b2dddf3636497ca3d62a7719c696ed"
}’
Response
{
"code":200,
"message":"OK",
“data”:
{
"sid":"NMMb6eb071d21124dbab20b095c25f8944a",
“phoneNumberSid”:”PN67b2dddf3636497ca3d62a7719c696ed”,
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"friendlyName":"Mask Number",
"phoneNumber":"12013507693",
"capabilities": {
"voice_capable": true,
"sms_capable": false,
"mms_capable": false,
"fax_capable": false
},
"isReserved":"false",
“inUse”:”0”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/maskednumbers/search/NMMb6eb071d21124dbab20b095c25f8944a"
}
}
If creation fails, this response is returned with the corresponding HTTP Error Code.
{
"errorCode": "460",
"message": "Application not found",
"data": {
"sid": "APP8ef9180b42924d96a62178768901c677aa"
}
}
Get a List of Mask Numbers
See what numbers are in the masking pool for all applications.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/maskednumbers/search?pageSize=2&page=0' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"result": [
{
"sid": "PH1d0c934f9bed411484d36a63067e345d",
"dateUpdated": "2020-05-11T10:37:23+0000",
"dateCreated": "2020-05-05T06:09:11+0000",
"accountEmail": "entpuser2@testent2.com",
"uri": "/numbermasking/maskednumbers/search/PH1d0c934f9bed411484d36a63067e345d",
"applicationSid": "APP56dd5e389aa64e90846be68645288b6b",
"phoneNumberSid": "PNbaa25148dc0d469f8050847439ba77fb",
"phoneNumber": "19713316943",
"isReserved": false,
"inUse": true
},
{
"sid": "PHccf45a3855274b01acf8172d62630881",
"dateUpdated": "2020-05-11T07:39:42+0000",
"dateCreated": "2020-05-05T06:00:54+0000",
"accountEmail": "entpuser2@testent2.com",
"uri": "/numbermasking/maskednumbers/search/PHccf45a3855274b01acf8172d62630881",
"applicationSid": "APP56dd5e389aa64e90846be68645288b6b",
"phoneNumberSid": "PN197e742df4d54efea2e70d82cdd435cd",
"phoneNumber": "15713316943",
"isReserved": false,
"inUse": false
}
],
"pageSize": 2,
"total": 5,
"page": 0,
"numPages": 3,
"start": 0,
"end": 1,
"firstPageUri": "/numbermasking/maskednumbers/search/?enterpriseSid=ENf625475702d44d29a8d605f28aaf7d3e&pageSize=2&page=0",
"uri": "/numbermasking/maskednumbers/search/?enterpriseSid=ENf625475702d44d29a8d605f28aaf7d3e&pageSize=2&page=1"
},
"code": 200,
"message": "OK"
}
Retrieve a Single Mask Number
You can retrieve a single number used in a mask pool if you have the ID for the phone number.
Request
curl -X GET \
https://cpaas.mittoapi.com/numbermasking/maskednumbers/search/NMMb6eb071d21124dbab20b095c25f8944a \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"sid":"NMMb6eb071d21124dbab20b095c25f8944a",
“phoneNumberSid”:”PN67b2dddf3636497ca3d62a7719c696ed”,
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"phoneNumber":"12013507693",
"isReserved":"false",
“inUse”:”true”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/maskednumbers/search/NMMb6eb071d21124dbab20b095c25f8944a"
},
"code": 200,
"message": "OK"
}
Update a Mask Number
You can update a mask number to list it as reserved or not.
Request
curl -X PUT \
'https://cpaas.mittoapi.com/numbermasking/maskednumbers/NMMb6eb071d21124dbab20b095c25f8944a' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"isReserved" : "true"
}'
Response
Successful Response
{
"data": {
"sid":"NMMb6eb071d21124dbab20b095c25f8944a",
“phoneNumberSid”:”PN67b2dddf3636497ca3d62a7719c696ed”,
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"phoneNumber":"12013507693",
"isReserved":"true",
“inUse”:”true”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/maskednumbers/search/NMMb6eb071d21124dbab20b095c25f8944a"
},
"code": 200,
"message": "OK"
}
Unsuccessful Response
{
"errorCode": "471",
"message": "Phone Number not found",
"data": {
"sid":"NMMb6eb071d21124dbab20b095c25f8944a",
"isReserved" : "true"
}
}
Remove a Masked Number From the Application Masked Number Pool
You can remove a masked number from the masked number pool for an application. After you remove a number from a pool, it is available to be added in other applications’ pools.
Request
curl -X DELETE \
'https://cpaas.mittoapi.com/numbermasking/maskednumbers/NMMb6eb071d21124dbab20b095c25f8944a' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
Successful Response
{
"data": {
"sid":"NMMb6eb071d21124dbab20b095c25f8944a",
“phoneNumberSid”:”PN67b2dddf3636497ca3d62a7719c696ed”,
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"phoneNumber":"12013507693",
"isReserved":"false",
“inUse”:”true”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/maskednumbers/search/NMMb6eb071d21124dbab20b095c25f8944a"
},
"code": 200,
"message": "OK"
}
Unsuccessful Response
{
"code":471,
"message":"Phone Number not found",
“data”:
{
“sid":"NMAb6eb071d21124dbab20b095c25f1274f"
}
}
Create a Context
A context is a single instance of two individuals communicating. It belongs to an application and maps two participants. An example context would be between a taxi driver and a customer. It can be active for a predefined period of time, or it can be deactivated upon request via API call.
Request
curl -X POST \
'https://cpaas.mittoapi.com/numbermasking/contexts' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name" : "TestSession1"
}'
Response
Successful Response
{
"code":200,
"message":"OK",
“data”:
{
"sid":"NMCb6eb071d21124dbab20b095c25f8932x",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name":"TestSession1",
"ttl":"600",
"mode":"voice-only",
"status":"open",
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/contexts/search/NMCb6eb071d21124dbab20b095c25f8932x"
}
}
Unsuccessful Response
{
"errorCode": "460",
"message": "Application not found",
"data": {
"sid": "APP0088803a42d24a64bba89669a02e991aaa"
}
}
Get a List of Contexts
Retrieve a list of contexts associated with an application.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/contexts/search?pageSize=2&page=0' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"result": [
{
"sid":"NMCb6eb071d21124dbab20b095c25f8932x",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name":"TestSession1",
"ttl":"600",
"mode":"voice-only",
"status":"open",
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/contexts/search/NMCb6eb071d21124dbab20b095c25f8932x"
},
{
"sid":"NMCb6eb071d21124dbab20b095c25f1234q",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name":"TestSession2",
"ttl":"3600",
"mode":"voice-only",
"status":"open",
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"dateLastInteraction":"2019-07-22 10:53:51",
"url":/numbermasking/contexts/search/NMCb6eb071d21124dbab20b095c25f1234q"
}
],
"pageSize": 2,
"total": 3,
"page": 0,
"numPages": 2,
"start": 0,
"end": 1,
"firstPageUri": "/numbermasking/contexts/search/?pageSize=2&page=0",
"nextPageUri": "/numbermasking/contexts/search/?pageSize=2&page=1",
"uri": "/numbermasking/contexts/search/?pageSize=2&page=0"
},
"code": 200,
"message": "OK"
}
Get a Single Context
You can retrieve a specific context for an application if you have the context’s unique ID.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/contexts/search/CTXb6eb071d21124dbab20b095c25f8932x' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"sid":"NMCb6eb071d21124dbab20b095c25f8932x",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name":"TestSession1",
"ttl":"600",
"mode":"voice-only",
"status":"open",
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"uri":/numbermasking/contexts/search/NMCb6eb071d21124dbab20b095c25f8932x”
},
"code": 200,
"message": "OK"
}
Update a Context
Update a context’s time to live to be longer or shorter. You can also update the status of the context from closed to open, open to closed, or in_progress to closed.
Request
curl -X PUT \
'https://cpaas.mittoapi.com/numbermasking/contexts/NMCb6eb071d21124dbab20b095c25f8932x' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"ttl" : "3600"
}'
Response
Successful Response
{
"data": {
"sid":"NMCb6eb071d21124dbab20b095c25f8932x",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name":"TestSession1",
"ttl":"3600",
"mode":"voice-only",
"status":"open",
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/contexts/search/NMCb6eb071d21124dbab20b095c25f8932x”
},
"code": 200,
"message": "OK"
}
Unsuccessful Response
{
"errorCode": "466",
"message": "Context name not unique",
"data": {
"name": "TestSession1"
}
}
Delete a Context
When participants finish communicating, you can delete their context.
Request
curl -X DELETE \
'https://cpaas.mittoapi.com/numbermasking/contexts/CTXb6eb071d21124dbab20b095c25f8932x' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
Successful Response
{
"data": {
"sid":"CTXb6eb071d21124dbab20b095c25f8932x",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
"name":"TestSession1",
"ttl":"600",
"mode":"voice-only",
"status":"closed",
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 11:53:51",
"url":/numbermasking/contexts/search/CTXb6eb071d21124dbab20b095c25f8932x"
},
"code": 200,
"message": "OK"
}
Unsuccessful Response
{
"code":467,
"message":"Context status closed",
“data”:
{
“sid":"NMAb6eb071d21124dbab20b095c25f1274f",
“name”:”MyTestApplication”,
“status”:”closed”,
“ttl”:”600”,
“numberSelectionBehavior”:”avoid-sticky”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-08-22 11:53:51",
"uri":/numbermasking/applications/search/NMAb6eb071d21124dbab20b095c25f1274f "
}
}
Add Participants to a Context
When two or more parties communicate with one another, they must be part of the same context within an application. You can add each participant with a POST request.
Request
curl -X POST \
https://cpaas.mittoapi.com/numbermasking/participants \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
"participantPhoneNumber" : "15713316943"
}’
Response
Successful Response
{
"code":200,
"message":"OK",
“data”:
{
"sid":"NMPb6eb071d21124dbab20b095c25f1111d",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“participantPhoneNumber”:”15713316943”,
“friendlyName”:”Mobile”,
“maskPhoneNumber”:”12013507693”,
“maskPhoneNumberSid”:”NMMb6eb071d21124dbab20b095c25f8944a”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f1111d"
}
}
Unsuccessful Response
{
"errorCode": "465",
"message": "Context not found",
"data": {
"sid": "CTXd6ecc4d93e804024a8c211b76391df97a"
}
}
Get a List of Context Participants
You can get a list of participants for a specific context, or across multiple contexts. This example shows how to get a list of all participants across contexts.
Request
curl -X GET \
https://cpaas.mittoapi.com/numbermasking/participants/search?pageSize=2&page=0 \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"result": [
{
"sid":"NMPb6eb071d21124dbab20b095c25f1111d",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“participantPhoneNumber”:”15713316943”,
“friendlyName”:”Mobile”,
“maskPhoneNumber”:”12013507693”,
“maskPhoneNumberSid”:”NMMb6eb071d21124dbab20b095c25f8944a”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f1111d"
},
{
"sid":"NMPb6eb071d21124dbab20b095c25f2222e",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“participantPhoneNumber”:”15713316944”,
“friendlyName”:”Mobile2”,
“maskPhoneNumber”:”12012444945”,
“maskPhoneNumberSid”:”NMMb6eb071d21124dbab20b095c25f8955b”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f2222e"
}
],
"pageSize": 2,
"total": 3,
"page": 0,
"numPages": 2,
"start": 0,
"end": 1,
"firstPageUri": "/numbermasking/participants/search/?pageSize=2&page=0",
"nextPageUri": "/numbermasking/participants/search/?pageSize=2&page=1",
"uri": "/numbermasking/contexts/participants/?pageSize=2&page=0"
},
"code": 200,
"message": "OK"
}
Retrieve a Single Participant From a Context
This example shows you how to retrieve a specific participant from a specific context.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f1111d' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"sid":"NMPb6eb071d21124dbab20b095c25f1111d",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“participantPhoneNumber”:”15713316943”,
“friendlyName”:”Mobile”,
“maskPhoneNumber”:”12013507693”,
“maskPhoneNumberSid”:”NMMb6eb071d21124dbab20b095c25f8944a”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f1111d"
},
"code": 200,
"message": "OK"
}
Remove a Participant From a Context
You can remove a participant from a context with this example. If there are ongoing calls, those will continue to completion, but no new calls can be made.
Request
curl -X DELETE \
'https://cpaas.mittoapi.com/numbermasking/participants/NMPb6eb071d21124dbab20b095c25f1111d' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
Successful Response
{
"data": {
"sid":"NMPb6eb071d21124dbab20b095c25f1111d",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“participantPhoneNumber”:”15713316943”,
“friendlyName”:”Mobile”,
“maskPhoneNumber”:”12013507693”,
“maskPhoneNumberSid”:”NMMb6eb071d21124dbab20b095c25f8944a”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f1111d"
},
"code": 200,
"message": "OK"
}
Unsuccessful Response
{
"code":482,
"message":"Participant already removed",
“data”:
{
"sid":"NMPb6eb071d21124dbab20b095c25f1111d",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“participantPhoneNumber”:”15713316943”,
“friendlyName”:”Mobile”,
“maskPhoneNumber”:”12013507693”,
“maskPhoneNumberSid”:”NMMb6eb071d21124dbab20b095c25f8944a”,
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
“dateRemoved”:”2019-07-22 11:53:51",
"url":/numbermasking/participants/search/NMPb6eb071d21124dbab20b095c25f1111d"
}
}
Get a List of Interactions
An interaction is a read-only call detail record for a given context. Each interaction represents a single communication caller and called participant.
Request
curl -X GET \
'https://cpaas.mittoapi.com/numbermasking/interactions/search' \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"result": [
{
"sid":"NMIb6eb071d21124dbab20b095c25f0007k",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“inboundParticipantSid”:"NMPb6eb071d21124dbab20b095c25f1111d",
“inboundTargetSid”:"ID308543a39dfd49b7a7231df9622763d8-CAf397453213fc43208e4d238e79809e99",
“inboundParticipantPhoneNumber”:"15713316943",
“inboundMaskPhoneNumber”:"12013507693",
“inboundChannelStatus”:”completed”,
“outboundParticipantSid”:"NMPb6eb071d21124dbab20b095c25f2222e",
“outboundTargetSid”:"ID1f2a2222772f4195948d040a2ccc648c-CA019d4b96e188484caec75b8b906ceb51",
“outboundParticipantPhoneNumber”:"15713316944",
“outboundMaskPhoneNumber”:"12012444945",
“outboundChannelStatus”:”completed”,
type:"voice",
"data": {
"duration": "28"
},
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/interactions/search/NMIb6eb071d21124dbab20b095c25f0007k"
},
{
"sid":"NMIb6eb071d21124dbab20b095c25f0008p",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“inboundParticipantSid”:"NMPb6eb071d21124dbab20b095c25f1111d",
“inboundTargetSid”:"ID308543a39dfd49b7a7231df9622763d8-CAf397453213fc43208e4d238e79809e97",
“inboundParticipantPhoneNumber”:"15713316943",
“inboundMaskPhoneNumber”:"12013507693",
“inboundChannelStatus”:”completed”,
“outboundParticipantSid”:"NMPb6eb071d21124dbab20b095c25f2222e",
“outboundTargetSid”:"ID1f2a2222772f4195948d040a2ccc648c-CA019d4b96e188484caec75b8b906ceb52",
“outboundParticipantPhoneNumber”:"15713316944",
“outboundMaskPhoneNumber”:"12012444945",
“outboundChannelStatus”:”completed”,
type:"voice",
"data": {
"duration": "294"
},
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 11:53:51",
"dateUpdated":"2019-07-22 11:53:51",
"url":/numbermasking/interactions/search/NMIb6eb071d21124dbab20b095c25f0008p"
}
],
"pageSize": 2,
"total": 3,
"page": 0,
"numPages": 2,
"start": 0,
"end": 1,
"firstPageUri": "/numbermasking/interactions/search/?pageSize=2&page=0",
"nextPageUri": "/numbermasking/interactions/search/?pageSize=2&page=1",
"uri": "/numbermasking/interactions/participants/?pageSize=2&page=0"
},
"code": 200,
"message": "OK"
}
Get a Single Interaction
You can retrieve a single interaction if you have the unique ID for the interaction.
Request
curl -X GET \
https://cpaas.mittoapi.com/numbermasking/interactions/search/NMIb6eb071d21124dbab20b095c25f0007k \
--user ' {your_account_SID}:{your_account_token}' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
Response
{
"data": {
"sid":"NMIb6eb071d21124dbab20b095c25f0007k",
"applicationSid":"NMAb6eb071d21124dbab20b095c25f1274f",
“contextSid”:”NMCb6eb071d21124dbab20b095c25f8932x”,
“inboundParticipantSid”:"NMPb6eb071d21124dbab20b095c25f1111d",
“inboundTargetSid”:"ID308543a39dfd49b7a7231df9622763d8-CAf397453213fc43208e4d238e79809e99",
“inboundParticipantPhoneNumber”:"15713316943",
“inboundMaskPhoneNumber”:"12013507693",
“inboundChannelStatus”:”completed”,
“outboundParticipantSid”:"NMPb6eb071d21124dbab20b095c25f2222e",
“outboundTargetSid”:"ID1f2a2222772f4195948d040a2ccc648c-CA019d4b96e188484caec75b8b906ceb51",
“outboundParticipantPhoneNumber”:"15713316944",
“outboundMaskPhoneNumber”:"12012444945",
“outboundChannelStatus”:”completed”,
type:"voice",
"data": {
"duration": "28"
},
“accountEmail”:”email@company.com”,
"dateCreated":"2019-07-22 09:53:51",
"dateUpdated":"2019-07-22 09:53:51",
"url":/numbermasking/interactions/search/NMIb6eb071d21124dbab20b095c25f0007k"
},
"code": 200,
"message": "OK"
}