Disable SMS on Number
Disable SMS on Number
DELETE https://api.stage.opentact.org/rest/lease/tn/number/subscription/sms
This API is used to disable SMS on Number
Query Parameters
| Name | Type | Description |
|---|---|---|
Tn_lease* | String | This field contains both tn_lease UUID and phone number to disable SMS on the number. |
Headers
| Name | Type | Description |
|---|---|---|
X-AUth token* | String | JWT-Token |
{
"success": true,
"payload": {
"uuid": "c5cc6326-0023-43d8-81a5-e7b7e019919d",
"type": "sms",
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"messaging_profile": {
"uuid": "c5cc6326-0023-43d8-81a5-e7b7e019919d",
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"callback_url": null,
"name": "default messaging profile",
"operators": [
{
"name": "TMobile",
"surcharge_sms": 0.001,
"country": {
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"a2": "US",
"a3": "USA",
"name": "UNITED STATES",
"n": 840,
"country_code": 1,
"national_code": null
},
"sms": true,
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z"
}
]
},
"sms_campaign": {
"is_active": false,
"campaignId": "CHEOGK3",
"vertical": "FINANCIAL",
"description": "Campaign description",
"usecase": "MARKETING",
"sample1": "Verification code {number}",
"sample2": "Account balance {number}",
"sample3": "Account verification url {url}",
"sample4": "Welcome {word}, login url {url}",
"sample5": "Welcome {word}{cr}login url {url}",
"subscriberHelp": true,
"helpMessage": "help message",
"subscriberOptin": true,
"subscriberOptout": true,
"autoRenewal": true,
"embeddedLink": false,
"embeddedPhone": false,
"numberPool": false,
"ageGated": false,
"directLending": false,
"affiliateMarketing": false,
"deleted_on": null,
"messageFlow": null,
"mnoIds": [],
"expired_on": "2023-01-04T07:52:58.191Z",
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"subUsecases": [],
"blacklist_count": 0,
"stop_sms_count": 0,
"sms_sent_count": 0,
"dca_share": [
{
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"uuid": "7b8f87f1-8988-4e83-9608-3285b448a05f",
"status": "ACCEPTED",
"downstream": "STLTZVV",
"upstream": "SYNIV",
"upstream_status": "REGISTERED",
"upstream_registered_on": "2023-01-04T07:52:58.191Z",
"upstream_failed_on": "2023-01-04T07:52:58.191Z",
"upstream_expired_on": null,
"upstream_reason": null
}
],
"sms_brand": {
"brandId": "BERV56F",
"is_active": true,
"brand_type": "PUBLIC_PROFIT",
"brandRelationship": "BASIC_ACCOUNT",
"displayName": "ABC inc",
"companyName": "ABC inc",
"stockExchange": "NASDAQ",
"stockSymbol": "ABC",
"vertical": "COMMUNICATION",
"ein": "123456",
"einIssuingCountry": {
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"a2": "US",
"a3": "USA",
"name": "UNITED STATES",
"n": 840,
"country_code": 1,
"national_code": null
},
"altBusinessId": "654321",
"altBusinessIdType": "NONE",
"phone": "+15555551234",
"street": "Wall str",
"city": "New York",
"state": "NY",
"postalCode": "1234",
"country": {
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"a2": "US",
"a3": "USA",
"name": "UNITED STATES",
"n": 840,
"country_code": 1,
"national_code": null
},
"email": "abc@ggmail.com",
"website": "https://google.com",
"firstName": "Name",
"lastName": "Last name",
"identityStatus": "UNVERIFIED",
"feedback": [
{
"id": "TAX_ID",
"displayName": "Tax Id",
"description": "Tax id does not match with the company name or business type.",
"fields": [
"ein",
"companyName",
"entityType"
]
}
],
"vetting": [
{
"evpId": "AEGIS",
"vettingId": "02310c7b-1349-4bdd-997e-08da4e7eba4b",
"vettingClass": "STANDARD",
"vettedDate": null,
"vettingStatus": "ACTIVE",
"vettingScore": 80,
"vettingToken": null,
"vettingDetails": {},
"reasons": null
}
]
},
"created_by": {
"uuid": "0116f6d1-1280-44b2-9134-da48509ec575",
"email": "info@opentact.org",
"wss_online": true,
"role": "User",
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"deleted_on": null,
"phone_number": "+1234567890",
"dob": "2023-01-04T07:52:58.191Z",
"avatar": "https://google/image.png",
"first_name": "First Name",
"last_name": "Last Name",
"gender": "Female"
},
"modified_by": {
"uuid": "0116f6d1-1280-44b2-9134-da48509ec575",
"email": "info@opentact.org",
"wss_online": true,
"role": "User",
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"deleted_on": null,
"phone_number": "+1234567890",
"dob": "2023-01-04T07:52:58.191Z",
"avatar": "https://google/image.png",
"first_name": "First Name",
"last_name": "Last Name",
"gender": "Female"
}
},
"created_by": {
"uuid": "0116f6d1-1280-44b2-9134-da48509ec575",
"email": "info@opentact.org",
"wss_online": true,
"role": "User",
"created_on": "2023-01-04T07:52:58.191Z",
"modified_on": "2023-01-04T07:52:58.191Z",
"deleted_on": null,
"phone_number": "+1234567890",
"dob": "2023-01-04T07:52:58.191Z",
"avatar": "https://google/image.png",
"first_name": "First Name",
"last_name": "Last Name",
"gender": "Female"
}
}
}{
"success": false,
"message": "string",
"status": 400,
"meta": "string",
"fields": {
"params.to": {
"message": "invalid integer number",
"value": "qwerty123456789"
}
}
}{
"success": false,
"message": "string",
"status": 403,
"meta": "string",
"fields": {
"params.to": {
"message": "invalid integer number",
"value": "qwerty123456789"
}
}
}{
"success": false,
"message": "string",
"status": 404,
"meta": "string",
"fields": {
"params.to": {
"message": "Not found",
"value": "qwerty123456789"
}
}
}{
"success": false,
"message": "string",
"status": 500,
"meta": "string",
"fields": {
"params.to": {
"message": "invalid integer number",
"value": "qwerty123456789"
}
}
}Last updated