SMS senden

Wenn Sie den Versand von Benachrichtigungen und Marketing-SMS automatisieren möchten, können Sie diese API aufrufen. Geben Sie die SMS-Vorlagen-ID und die Zielempfänger an, und das System sendet SMS-Nachrichten automatisch basierend auf dem Vorlageninhalt.

Hinweis zur Plattformkonfiguration Vor dem Aufruf müssen Sie die folgende Konfiguration in der EngageLab SMS Console abschließen:

• SMS-Vorlageneinstellungen: Bevor Sie die API aufrufen, gehen Sie bitte zu Vorlagenverwaltung, um eine SMS-Vorlage anzupassen und einzureichen. Die Vorlage muss die Prüfung bestehen, bevor Sie die Vorlagen-ID verwenden können.
• API-Key-Konfiguration: Gehen Sie zu API Key, um einen API-Basic-Authentifizierungsschlüssel zu erstellen.

Anfrage-URL

POST https://smsapi.engagelab.com/v1/messages

Aufruf-Authentifizierung

Bitte lesen Sie Aufruf-Authentifizierung, um zu erfahren, wie Sie API-Anfragen authentifizieren.

Anfragebeispiel

Anfrage-Header

              
              POST /v1/messages  HTTP/1.1  
Content-Type: application/json  
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Anfragetext

              
              {
    "to": [
        "923700056581"
    ],
    "template": {
        "id": "1233",
        "params": {
            "content": "Verification code: 039487. This code will expire in 5 minutes. You are attempting to create your account."
        }
    }
}

            

Anfrageparameter

Ein Anfrageobjekt wird im JSON-Format ausgedrückt, daher muss der Anfrage-Header Content-Type: application/json enthalten.

Beschreibung von params

Für benutzerdefinierte Variablenfelder im Vorlageninhalt, die beim Erstellen einer Vorlage festgelegt wurden, müssen die Werte über params zugewiesen werden. Wenn der Vorlageninhalt beispielsweise Hi {{name}}, welcome to EngageLab lautet, müssen Sie den Parameter params: {"name": "Bob"} zuweisen.

Weitere Anfragebeispiele

1. Benutzerdefinierten Benachrichtigungsinhalt senden:

              
              {
    "to": ["+6591234567"],
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

2. Benutzerdefinierten Marketinginhalt senden:

              
              {
    "to": ["+6591234567"],
    "template": {
        "id": "marketing-template",
        "params": {
            "name": "EngageLab",
            "promotion": "30%"
        }
    }
}

            

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode ist 200, und der Antworttext enthält die folgenden Felder:

Erfolgsbeispiel (Einzelziel)

              
              {
    "plan_id": "1972488990548348928",
    "total_count": 1,
    "accepted_count": 1,
    "message_id": "1972488990804201472"
}

            

Erfolgsbeispiel (Mehrere Ziele)

              
              {
    "plan_id": "1972484198153367552",
    "total_count": 2,
    "accepted_count": 2
}

            

Erfolgsbeispiel (Geplante Aufgabe)

              
              {
    "plan_id": "1972492618659033088",
    "total_count": 1,
    "accepted_count": 1,
    "schedule_info": {
        "task_id": 1972492621368553472
    }
}

            

Fehlerantwort

Der HTTP-Statuscode ist 200 (in einigen Ausnahmefällen) oder 4xx/5xx, und der Antworttext enthält die folgenden Felder:

Fehlerbeispiel

              
              {
    "plan_id": "1972490061974913024",
    "total_count": 1,
    "accepted_count": 1,
    "message": "err xxxx",
    "code": 1
}

            

Fehlercodes