sms-notifications

Operations addressed under /sms-notifications — 5 operations.

report-sms

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/report

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

report-sms › Request Body

groupId

string · required

messageIds

string[]

report-sms › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

responseCode

string

responseMessage

string

object

POST/sms-notifications/report

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/report \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "groupId": "",
  "messageIds": [
    ""
  ]
}'

Example Request Body

{
  "groupId": "",
  "messageIds": [
    ""
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "responseCode": "responseCode",
  "responseMessage": "responseMessage",
  "resultMessageReports": {
    "channel": "channel",
    "deliveredDate": {},
    "errorCode": "errorCode",
    "gsmNumber": "gsmNumber",
    "messageId": "messageId",
    "responseCode": "responseCode",
    "sMSValueToLength": {},
    "sendDate": {},
    "sendRetryCount": {},
    "sendedSMSCount": {},
    "smsId": "00000000-0000-0000-0000-000000000000",
    "smsTo": "smsTo",
    "status": "status"
  }
}

json

application/json

report-sms-detail

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/report-detail

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

report-sms-detail › Request Body

endDate

string · date · required

gsmNumber

string · required

startDate

string · date-time · required

originator

string

report-sms-detail › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

description

string

object

status

integer · int32

Permitted values — validated against the status parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Open`	no label seeded
`2`	`Close`	ar: إغلاق
`3`	`Death`	ar: الموت
`4`	`Unseen`	ar: غير مرئي
`5`	`Renouncing Citizenship`	ar: التخلي عن المواطنة
`14`	`Stopped`	ar: توقف
`15`	`Secret`	ar: سرّ

url

string

POST/sms-notifications/report-detail

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/report-detail \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "endDate": "",
  "gsmNumber": "",
  "originator": "",
  "startDate": ""
}'

Example Request Body

{
  "endDate": "",
  "gsmNumber": "",
  "originator": "",
  "startDate": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "description": "description",
  "reportSMSDetailed": {
    "ID": {},
    "createDate": {},
    "deliveredDate": {},
    "messageText": "messageText",
    "originator": "originator",
    "phone": "phone",
    "responseCode": "responseCode",
    "sMSValueToLength": {},
    "sendDate": {},
    "sendRetryCount": {},
    "sendedSMSCount": {},
    "status": 0
  },
  "status": 0,
  "url": "url"
}

json

application/json

send-broadcast-sms

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/send-broadcast

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

send-broadcast-sms › Request Body

broadcastMessage

string · required

blacklistFilter

string

brandCode

string

broadcastMessageParametric

string

bwFilter

string

channel

string

domesticFilter

string

exclusionStartTime

string

exclusionexPiretime

string

expireDate

string · date-time

forceEnglish

string

iysCode

string

iysFilter

string

mnpCheckinDay

string

multiChannelType

string

multiChannels

string[]

multiOriginators

string[]

multiPart

string

originator

string

origpId

string

realTime

string

recipientType

string

reference

string

retailerCode

string

sequence

string

simCheckinDay

string

object[]

startDate

string · date-time

state

integer · int32

totalCount

string

x

string

send-broadcast-sms › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

responseCode

string

object[]

responseMessage

string

POST/sms-notifications/send-broadcast

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/send-broadcast \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "blacklistFilter": "",
  "brandCode": "",
  "broadcastMessage": "",
  "broadcastMessageParametric": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}'

Example Request Body

{
  "blacklistFilter": "",
  "brandCode": "",
  "broadcastMessage": "",
  "broadcastMessageParametric": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "responseCode": "responseCode",
  "responseGroupIdArray": [
    {
      "gsmNumber": "gsmNumber",
      "messageid": "messageid",
      "status": "status"
    }
  ],
  "responseMessage": "responseMessage"
}

json

application/json

send-instant-sms

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/send-instant

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

send-instant-sms › Request Body optional

blacklistFilter

string

brandCode

string

bwFilter

string

channel

string

domesticFilter

string

exclusionStartTime

string

exclusionexPiretime

string

expireDate

string · date-time

forceEnglish

string

iysCode

string

iysFilter

string

mnpCheckinDay

string

multiChannelType

string

multiChannels

string[]

multiOriginators

string[]

multiPart

string

originator

string

origpId

string

realTime

string

recipientType

string

reference

string

retailerCode

string

sequence

string

simCheckinDay

string

object[]

startDate

string · date-time

state

integer · int32

totalCount

string

x

string

send-instant-sms › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

responseCode

string

object[]

responseMessage

string

POST/sms-notifications/send-instant

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/send-instant \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "blacklistFilter": "",
  "brandCode": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageText": "",
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}'

Example Request Body

{
  "blacklistFilter": "",
  "brandCode": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageText": "",
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "responseCode": "responseCode",
  "responseGroupIdArray": [
    {
      "gsmNumber": "gsmNumber",
      "messageid": "messageid",
      "status": "status"
    }
  ],
  "responseMessage": "responseMessage"
}

json

application/json

send-otp

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/send-otp

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

send-otp › Request Body

body

string · required

gsmNumber

string · required

smsNotificationDetailId

string · uuid · required

send-otp › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

rm-segments verify

Integration Service

sms-notifications

Operations addressed under /sms-notifications — 5 operations.

report-sms

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/report

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

report-sms › Request Body

groupId

string · required

messageIds

string[]

report-sms › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

responseCode

string

responseMessage

string

object

POST/sms-notifications/report

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/report \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "groupId": "",
  "messageIds": [
    ""
  ]
}'

Example Request Body

{
  "groupId": "",
  "messageIds": [
    ""
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "responseCode": "responseCode",
  "responseMessage": "responseMessage",
  "resultMessageReports": {
    "channel": "channel",
    "deliveredDate": {},
    "errorCode": "errorCode",
    "gsmNumber": "gsmNumber",
    "messageId": "messageId",
    "responseCode": "responseCode",
    "sMSValueToLength": {},
    "sendDate": {},
    "sendRetryCount": {},
    "sendedSMSCount": {},
    "smsId": "00000000-0000-0000-0000-000000000000",
    "smsTo": "smsTo",
    "status": "status"
  }
}

json

application/json

report-sms-detail

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/report-detail

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

report-sms-detail › Request Body

endDate

string · date · required

gsmNumber

string · required

startDate

string · date-time · required

originator

string

report-sms-detail › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

description

string

object

status

integer · int32

Permitted values — validated against the status parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Open`	no label seeded
`2`	`Close`	ar: إغلاق
`3`	`Death`	ar: الموت
`4`	`Unseen`	ar: غير مرئي
`5`	`Renouncing Citizenship`	ar: التخلي عن المواطنة
`14`	`Stopped`	ar: توقف
`15`	`Secret`	ar: سرّ

url

string

POST/sms-notifications/report-detail

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/report-detail \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "endDate": "",
  "gsmNumber": "",
  "originator": "",
  "startDate": ""
}'

Example Request Body

{
  "endDate": "",
  "gsmNumber": "",
  "originator": "",
  "startDate": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "description": "description",
  "reportSMSDetailed": {
    "ID": {},
    "createDate": {},
    "deliveredDate": {},
    "messageText": "messageText",
    "originator": "originator",
    "phone": "phone",
    "responseCode": "responseCode",
    "sMSValueToLength": {},
    "sendDate": {},
    "sendRetryCount": {},
    "sendedSMSCount": {},
    "status": 0
  },
  "status": 0,
  "url": "url"
}

json

application/json

send-broadcast-sms

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/send-broadcast

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

send-broadcast-sms › Request Body

broadcastMessage

string · required

blacklistFilter

string

brandCode

string

broadcastMessageParametric

string

bwFilter

string

channel

string

domesticFilter

string

exclusionStartTime

string

exclusionexPiretime

string

expireDate

string · date-time

forceEnglish

string

iysCode

string

iysFilter

string

mnpCheckinDay

string

multiChannelType

string

multiChannels

string[]

multiOriginators

string[]

multiPart

string

originator

string

origpId

string

realTime

string

recipientType

string

reference

string

retailerCode

string

sequence

string

simCheckinDay

string

object[]

startDate

string · date-time

state

integer · int32

totalCount

string

x

string

send-broadcast-sms › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

responseCode

string

object[]

responseMessage

string

POST/sms-notifications/send-broadcast

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/send-broadcast \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "blacklistFilter": "",
  "brandCode": "",
  "broadcastMessage": "",
  "broadcastMessageParametric": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}'

Example Request Body

{
  "blacklistFilter": "",
  "brandCode": "",
  "broadcastMessage": "",
  "broadcastMessageParametric": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "responseCode": "responseCode",
  "responseGroupIdArray": [
    {
      "gsmNumber": "gsmNumber",
      "messageid": "messageid",
      "status": "status"
    }
  ],
  "responseMessage": "responseMessage"
}

json

application/json

send-instant-sms

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/send-instant

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

send-instant-sms › Request Body optional

blacklistFilter

string

brandCode

string

bwFilter

string

channel

string

domesticFilter

string

exclusionStartTime

string

exclusionexPiretime

string

expireDate

string · date-time

forceEnglish

string

iysCode

string

iysFilter

string

mnpCheckinDay

string

multiChannelType

string

multiChannels

string[]

multiOriginators

string[]

multiPart

string

originator

string

origpId

string

realTime

string

recipientType

string

reference

string

retailerCode

string

sequence

string

simCheckinDay

string

object[]

startDate

string · date-time

state

integer · int32

totalCount

string

x

string

send-instant-sms › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

responseCode

string

object[]

responseMessage

string

POST/sms-notifications/send-instant

curl https://dg-sandbox.dgpays.com/integration-service/sms-notifications/send-instant \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "blacklistFilter": "",
  "brandCode": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageText": "",
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}'

Example Request Body

{
  "blacklistFilter": "",
  "brandCode": "",
  "bwFilter": "",
  "channel": "",
  "domesticFilter": "",
  "exclusionStartTime": "",
  "exclusionexPiretime": "",
  "expireDate": "",
  "forceEnglish": "",
  "iysCode": "",
  "iysFilter": "",
  "mnpCheckinDay": "",
  "multiChannelType": "",
  "multiChannels": [
    ""
  ],
  "multiOriginators": [
    ""
  ],
  "multiPart": "",
  "originator": "",
  "origpId": "",
  "realTime": "",
  "recipientType": "",
  "reference": "",
  "retailerCode": "",
  "sequence": "",
  "simCheckinDay": "",
  "smsMessages": [
    {
      "gsmNumber": "",
      "messageHeader": "",
      "messageId": "",
      "messageParams": [
        ""
      ],
      "messageText": "",
      "messageType": ""
    }
  ],
  "startDate": "",
  "state": 0,
  "totalCount": "",
  "x": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "responseCode": "responseCode",
  "responseGroupIdArray": [
    {
      "gsmNumber": "gsmNumber",
      "messageid": "messageid",
      "status": "status"
    }
  ],
  "responseMessage": "responseMessage"
}

json

application/json

send-otp

POST

https://dg-sandbox.dgpays.com/integration-service

/sms-notifications/send-otp

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

send-otp › Request Body

body

string · required

gsmNumber

string · required

smsNotificationDetailId

string · uuid · required

send-otp › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

rm-segments verify