CCC API v8.12.0.0

GetGatewayServiceSettings

The following routes are available for this service:
GET	/api/gateways/{GatewayGuid}/services/settings	Gets all of the settings a gateway needs for a specific service, including service message rules.

**GetGatewayServiceSettings** Parameters:
Name	Parameter	Data Type	Required	Description
GatewayGuid	path	Guid	Yes	Identifies the gateway instance.
ServiceGuid	body	Guid	No	Identifies the service instance.
Domain	body	String	No	The primary or secondary domain associated with the service.

**GatewayServiceSettingsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**GatewayServiceSettings** Parameters:
Name	Parameter	Data Type	Required
SystemUserEmailAddress	form	string	No
DefaultProPackage	form	string	No
CustomSMTPSenderEmail	form	string	No
CustomSMTPSenderName	form	string	No
CustomSMTPDNREmail	form	string	No
DiscardSameDomainNotifications	body	Boolean	No
SendNotificationViaServer	body	Boolean	No
MessageRules	body	GatewayServiceMessageRule[]	No

**GatewayService** Parameters:
Name	Parameter	Data Type	Required
ServiceGuid	body	Guid	No
ServiceName	form	string	No
MessagingApiUrl	form	string	No
GatewaySettingsUrl	form	string	No
ServiceCode	form	string	No
PrimaryDomain	form	string	No
SecondaryDomains	form	string[]	No

**GatewayServiceMessageRule** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceGuid	form	Guid	No

**GatewayMessageRule** Parameters:
Name	Parameter	Data Type	Required
MessageRuleGuid	form	Guid	No
GatewayGuid	form	Guid	No
Cost	form	long	No
Enabled	form	bool	No
CheckNextRuleIf	form	int	No
Description	form	string	No
MatchExpression	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/gateways/{GatewayGuid}/services/settings HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "systemUserEmailAddress": "String",
  "defaultProPackage": "String",
  "customSMTPSenderEmail": "String",
  "customSMTPSenderName": "String",
  "customSMTPDNREmail": "String",
  "discardSameDomainNotifications": false,
  "sendNotificationViaServer": false,
  "messageRules": [
    {
      "serviceGuid": "00000000000000000000000000000000",
      "messageRuleGuid": "00000000000000000000000000000000",
      "gatewayGuid": "00000000000000000000000000000000",
      "cost": 0,
      "enabled": false,
      "checkNextRuleIf": 0,
      "description": "String",
      "matchExpression": "String"
    }
  ],
  "serviceGuid": "00000000000000000000000000000000",
  "serviceName": "String",
  "messagingApiUrl": "String",
  "gatewaySettingsUrl": "String",
  "serviceCode": "String",
  "primaryDomain": "String",
  "secondaryDomains": [
    "String"
  ]
}