技術資料

error この記事は最終更新日から1年以上が経過しています。

リストの作成

参考: APIリファレンス

// リスト名を指定
$listname = '送信リスト1';
$data = array(
    'name' => $listname
);
$json_data = json_encode($data);
        
$api_url = "https://api.sendgrid.com/v3/contactdb/lists";
$headers = array(
    'Content-Type: application/json',
    'Authorization: Bearer '.SENDGRID_API_KEY
);

$ch = curl_init($api_url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if($status_code < 200 || $status_code >= 300){
    print "API error ==createList {$status_code}==";
    return FALSE;
}
$result = json_decode($response);
if(isset($result->errors[0])){
    print "API error ==createList {$result->errors[0]->message}==";
    return FALSE;
}
return $result->id;

上記処理で、リストのIDを返す。

リストの一覧取得

参考: APIリファレンス

$listname = '送信リスト1';

$api_url = "https://api.sendgrid.com/v3/contactdb/lists";
$opts = array('http' =>
    array(
        'header' => "Authorization: Bearer ".SENDGRID_API_KEY
    )
);
$context = stream_context_create($opts);
$result = @file_get_contents($api_url, false, $context);
$http_code = 0;
preg_match('/HTTP\/1\.[0|1|x] ([0-9]{3})/', $http_response_header[0], $matches);
$http_code = $matches[1];
if(!$result || $http_code != '200'){
    print "API error ==getListIdByType==";
    return FALSE;
}
$result_arr = json_decode($result);

$list_id = 0;
foreach($result_arr as $res){
    foreach($res as $list){
        if($list->name == $listname){
            $list_id = $list->id;
            break;
        }
    }
}
if($list_id == 0){
    return FALSE;
}
return $list_id;

上記の処理は、リストの一覧から、指定した名前のリストのIDを返す。

リストのIDが分かっていて、IDからリストの情報を取得する時は、こちらのAPIが使える。

メールアドレスをリストに追加する

参考: APIリファレンス

$list_id = '12345';
$mail = 'test@test.com';
$recipient_id = base64_encode($mail);

$api_url = "https://api.sendgrid.com/v3/contactdb/lists/{$list_id}/recipients/{$recipient_id}";
$headers = array(
    'Content-Type: application/json',
    'Authorization: Bearer '.SENDGRID_API_KEY
);

$ch = curl_init($api_url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if($status_code < 200 || $status_code >= 300){
    print "API error ==addSingleRecipient2List {$status_code}==";
    return FALSE;
}
$result = json_decode($response);
if(isset($result->errors)){
    print "API error ==addSingleRecipient2List {$result->errors[0]->message}==";
    return FALSE;
}
return TRUE;

その他リスト関連のAPIはContacts API ドキュメントに載ってる。