Forum Discussion

jeffshurtliff's avatar
jeffshurtliff
Boss
5 years ago

Getting 403 response when creating message with attachment using API v2 and Python

When creating messages using the Community API v2 and the Python requests library, it works fine when not trying to upload an attachment, as shown in the sanitized excerpt below.     >>> headers ...
  • WillB's avatar
    WillB
    5 years ago

    jeffshurtliff I got it working with the following code: 

     

    import requests

headers = {
    'li-api-session-key': 'XXXXXXXXXX_XXXXXXXXXXX_XXXXXXXXXXXX',
}

files = {
    'api.request': (None, '{\n"data":{\n"type":"message",\n"subject":"This is the message subject",\n"board":{\n"type":"board",\n"id":"KB1"\n},\n"attachments":{\n"list_item_type":"attachment",\n"items":[\n{\n"type":"attachment",\n"field":"attachment1",\n"filename":"pdf1.PDF"\n},\n{\n"type":"attachment",\n"field":"attachment2",\n"filename":"pdf2.PDF"\n}\n]\n}\n}\n}'),
    'attachment1': ('/Users/will.bowen/Documents/pdf1.PDF', open('/Users/will.bowen/Documents/pdf1.PDF', 'rb')),
    'attachment2': ('/Users/will.bowen/Documents/pdf2.PDF', open('/Users/will.bowen/Documents/pdf2.PDF', 'rb')),
}

response = requests.post('https://rsalink-stage.rsa.com/api/2.0/messages', headers=headers, files=files)
jeffshurtliff's avatar
jeffshurtliff
Boss

Hi WillB,

That was very helpful, thank you! I was able to find a Stack Overflow thread about the error which helped me realize that, despite it being in the Khoros dev docs tutorial examples, I needed to stop manually inserting the "content-type": "multipart/form-data" entry into the header when making the POST request, and just let it get defined as a multipart query on its own.

This allowed the query to return a normal response from the Community API, albeit an error message.  See below.

>>> response
<Response [500]>

>>> response.text
'{"status":"error","message":"Unable to parse the required Content-Body from the request.","data":{"type":"error_data","code":308,"developer_message":"Unexpected character (\'-\' (code 45)) in numeric value: expected digit (0-9) to follow minus sign, for valid numeric value","more_info":""},"metadata":{}}'

>>> response.request.body
<MultipartEncoder: {'api.request': (None, '{"data": {"type": "message", "board": {"id": "product-knowledge-base"}, "body": "This is an <b>API TEST</b> done in Python with an attached file.", "subject": "API Test with Attachment", "attachments": {"list_item_type": "attachment", "items": [{"type": "attachment", "field": "attachment1", "filename": "jive_id_bookmarklet.pdf"}]}}}', 'application/json'), 'attachment1': ('jive_id_bookmarklet.pdf', <_io.BufferedReader name='C:\\Users\\shurtj\\Downloads\\jive_id_bookmarklet.pdf'>)}>

I'm confused by the error though because from what I'm seeing, there is no field I'm using in the JSON that requires a numeric value and where a hyphen is found, unless it thinks the Board ID field should be an integer.  But that's not what the tutorial example shows...

These are the documents I've been referencing, per your request:

Thanks!

WillB's avatar
WillB
Khoros Alumni (Retired)
5 years ago

jeffshurtliff I got it working with the following code: 

 

import requests

headers = {
    'li-api-session-key': 'XXXXXXXXXX_XXXXXXXXXXX_XXXXXXXXXXXX',
}

files = {
    'api.request': (None, '{\n"data":{\n"type":"message",\n"subject":"This is the message subject",\n"board":{\n"type":"board",\n"id":"KB1"\n},\n"attachments":{\n"list_item_type":"attachment",\n"items":[\n{\n"type":"attachment",\n"field":"attachment1",\n"filename":"pdf1.PDF"\n},\n{\n"type":"attachment",\n"field":"attachment2",\n"filename":"pdf2.PDF"\n}\n]\n}\n}\n}'),
    'attachment1': ('/Users/will.bowen/Documents/pdf1.PDF', open('/Users/will.bowen/Documents/pdf1.PDF', 'rb')),
    'attachment2': ('/Users/will.bowen/Documents/pdf2.PDF', open('/Users/will.bowen/Documents/pdf2.PDF', 'rb')),
}

response = requests.post('https://rsalink-stage.rsa.com/api/2.0/messages', headers=headers, files=files)
  • jeffshurtliff's avatar
    jeffshurtliff
    Boss
    5 years ago

    Thank you very much, WillB!!  

    Your code snippet above helped me realize that I was inadvertently performing a JSON dump of the entire payload rather than just for the api.request portion.  Making that change allowed me to publish successfully with attachments.

    The finished function has been pushed to PyPI and GitHub and can be seen here.

    Thanks again!!