Freshdesk API创建包含附件抛出验证错误的便笺

Question

use GuzzleHttp\Client;

function insert_freshdesk_note($ticketId, $content, $attachments=null)
{
    if(is_null($content)) {
        return false;
    }

    $url = 'https://mydomain.freshdesk.com/api/v2/tickets/'.$ticketId.'/notes';
    $method = 'POST';
    $userName = config('freshdesk_api_key');
    $password = 'password';

    $data = (!empty($attachments)) ? [
        "attachments[]" => $attachments,
        "body" => $content,
        "private" => false,
    ] : [
        "body" => $content,
        "private" => false,
    ];

    $options = (!empty($attachments)) ? [
        'json' => $data,
        'auth' => [$userName, $password],
        'headers' => ['content-type' => 'multipart/form-data']
    ] : [
        'json' => $data,
        'auth' => [$userName, $password]
    ];

    $client = new Client();

    try {
        $response = $client->request($method, $url, $options);
        return json_decode($response->getBody(), true);
    } catch (Exception $e) {
        Log::error($e);
    }
}

上面的代码在没有附件的情况下运行良好，但当附件出现在图片中时，它会抛出以下错误：-

GuzzleHttp\Exception\ClientException: Client error: `POST https://mydomain.freshdesk.com/api/v2/tickets/13033/notes` resulted in a `400 Bad Request` response:
{"description":"Validation failed","errors":[{"field":"{\"attachments","message":"Unexpected/invalid field in request","

我正在根据文档工作，到目前为止，我已经走到了死胡同。我尝试了其他的排列和组合，但通过这些，我无法解决这个问题。

有谁能帮帮我。这里是freshdesk文档的链接，在$attachments[] = '@/path/to/xyz.ext‘中，这是一个特殊的链接。

函数调用将如下所示：

insert_freshdesk_note($this->freshdesk_ticket_id, $noteText, $image->image_full_path);

Answer 1

在上面的问题中，我试图使用GuzzleHTTP客户端、Laravel框架和PHP语言来实现笔记的添加。下面是它开始工作的源代码。

use GuzzleHttp\Client;

function insert_freshdesk_note($ticketId, $content, $attachments=null)
{   
    if(is_null($content)) {
        return false;
    }

    $url = 'https://mydomain.freshdesk.com/api/v2/tickets/'.$ticketId.'/notes';
    $method = 'POST';
    $userName = config('freshdesk_api_key');
    $password = 'password';

    $attachmentsFilePath = explode('/',$attachments);
    $fileName = end($attachmentsFilePath);

    $options = (!empty($attachments)) ? [
        'multipart' => [
            [
                'name'     => 'body',
                'contents' => $content,
            ],
            [
                'name'     => 'private',
                'contents' => "false",
            ],
            [
                'name'     => 'attachments[]',
                'contents' => fopen($attachments, 'r'),
                'filename' => $fileName,
            ],
        ],
        'auth' => [$userName, $password],
    ] : [
        'json' => [
            "body" => $content,
            "private" => false,
        ],
        'auth' => [$userName, $password]
    ];

    $client = new Client();

    try {
        $response = $client->request($method, $url, $options);
        return json_decode($response->getBody(), true);
    } catch (Exception $e) {
        Log::error($e);
    }
}

我们必须以多部分的方式发送数据，以便让Freshdesk后端了解数据在那里，在标题中写入multipart/form-type将无济于事。如果您查看的文档也包含和不包含下面的附件：

不带附件：-

curl -v -u user@yourcompany.com:test -H "Content-Type: application/json" -X POST -d '{ "body":"Hi tom, Still Angry", "private":false, "notify_emails":["tom@yourcompany.com"] }' 'https://domain.freshdesk.com/api/v2/tickets/3/notes'

附附件：-

curl -v -u user@yourcompany.com:test -F "attachments[]=@/path/to/attachment1.ext" -F "body=Hi tom, Still Angry" -F "notify_emails[]=tom@yourcompany.com" -X POST 'https://domain.freshdesk.com/api/v2/tickets/20/notes'

卷曲的区别是可以看到的。这是我忽略的缺失部分。